Merge pull request #3607 from hey-api/feat/py-dsl-method

feat: add class method node

Author: mrlubos

packages/openapi-python-tests/sdks/__snapshots__/opencode/default/sdk_gen.py

@@ -35,7 +35,7 @@ def dispose(self):
 
 
 class Project(Client):
-    def list_(self):
+    def list(self):
         """
         List all projects
 
@@ -64,7 +64,7 @@ def update(self):
 
 
 class Pty(Client):
-    def list_(self):
+    def list(self):
         """
         List PTY sessions
 
@@ -158,7 +158,7 @@ def ids(self):
 
         return self.client.get("/experimental/tool/ids")
 
-    def list_(self):
+    def list(self):
         """
         List tools
 
@@ -202,7 +202,7 @@ def get(self):
 
 
 class Session(Client):
-    def list_(self):
+    def list(self):
         """
         List sessions
 
@@ -443,7 +443,7 @@ def reply(self):
 
         return self.client.post("/permission/{requestID}/reply")
 
-    def list_(self):
+    def list(self):
         """
         List pending permissions
 
@@ -454,7 +454,7 @@ def list_(self):
 
 
 class Command(Client):
-    def list_(self):
+    def list(self):
         """
         List commands
 
@@ -485,7 +485,7 @@ def callback(self):
 
 
 class Provider(Client):
-    def list_(self):
+    def list(self):
         """
         List providers
 
@@ -538,7 +538,7 @@ def symbols(self):
 
 
 class File(Client):
-    def list_(self):
+    def list(self):
         """
         List files
 
@@ -681,7 +681,7 @@ def status(self):
 
 
 class Control(Client):
-    def next_(self):
+    def next(self):
         """
         Get next TUI request
 
@@ -797,7 +797,7 @@ def control(self) -> Control:
 
 
 class Auth_2(Client):
-    def set_(self):
+    def set(self):
         """
         Set auth credentials
 

packages/openapi-python/src/plugins/@hey-api/sdk/v1/node.ts

@@ -72,7 +72,7 @@ function childToNode(
   const cachedProp = plugin.external('functools.cached_property');
 
   return [
-    $.func(memberName)
+    $.method(memberName)
       .decorator(cachedProp)
       .param('self')
       .returns(refChild)
@@ -196,7 +196,7 @@ export function toNode(
     } else {
       if (index > 0 || node.hasBody) node.newline();
       const method = implementFn({
-        node: $.func(createFnSymbol(plugin, item), (m) =>
+        node: $.method(createFnSymbol(plugin, item), (m) =>
           attachComment({
             node: m,
             operation,

packages/openapi-python/src/py-dsl/decl/func.ts

@@ -1,4 +1,4 @@
-import type { AnalysisContext, NodeName } from '@hey-api/codegen-core';
+import type { AnalysisContext, NodeName, NodeNameSanitizer } from '@hey-api/codegen-core';
 import { isSymbol } from '@hey-api/codegen-core';
 
 import { py } from '../../ts-python';
@@ -22,10 +22,15 @@ const Mixed = AsyncMixin(
 
 export class FuncPyDsl extends Mixed {
   readonly '~dsl' = 'FuncPyDsl';
-  override readonly nameSanitizer = safeRuntimeName;
+  override readonly nameSanitizer: NodeNameSanitizer;
 
-  constructor(name: NodeName, fn?: (f: FuncPyDsl) => void) {
+  constructor(
+    name: NodeName,
+    fn?: (f: FuncPyDsl) => void,
+    options?: { nameSanitizer?: NodeNameSanitizer },
+  ) {
     super();
+    this.nameSanitizer = options?.nameSanitizer ?? safeRuntimeName;
     this.name.set(name);
     if (isSymbol(name)) {
       name.setKind('function');

packages/openapi-python/src/py-dsl/index.ts

@@ -71,6 +71,7 @@ import { WithPyDsl } from './stmt/with';
 // import { TypeTemplatePyDsl } from './type/template';
 // import { TypeTuplePyDsl } from './type/tuple';
 import { LazyPyDsl } from './utils/lazy';
+import { safeKeywordName } from './utils/name';
 
 const pyDsl = {
   /** Creates an array literal expression (e.g. `[1, 2, 3]`). */
@@ -147,12 +148,12 @@ const pyDsl = {
   /** Creates an import statement. */
   import: (...args: ConstructorParameters<typeof ImportPyDsl>) => new ImportPyDsl(...args),
 
-  /** Creates a keyword argument expression (e.g. `name=value`). */
-  kwarg: (...args: ConstructorParameters<typeof KwargPyDsl>) => new KwargPyDsl(...args),
-
   /** Creates an initialization block or statement. */
   // init: (...args: ConstructorParameters<typeof InitTsDsl>) => new InitTsDsl(...args),
 
+  /** Creates a keyword argument expression (e.g. `name=value`). */
+  kwarg: (...args: ConstructorParameters<typeof KwargPyDsl>) => new KwargPyDsl(...args),
+
   /** Creates a lazy, context-aware node with deferred evaluation. */
   lazy: <T extends py.Node>(...args: ConstructorParameters<typeof LazyPyDsl<T>>) =>
     new LazyPyDsl<T>(...args),
@@ -166,8 +167,12 @@ const pyDsl = {
   /** Creates an enum member declaration. */
   // member: (...args: ConstructorParameters<typeof EnumMemberTsDsl>) => new EnumMemberTsDsl(...args),
 
-  /** Creates a method declaration inside a class or object. */
-  // method: (...args: ConstructorParameters<typeof MethodTsDsl>) => new MethodTsDsl(...args),
+  /** Creates a class method declaration. */
+  method: ((name: NodeName, fn?: (f: FuncPyDsl) => void) =>
+    new FuncPyDsl(name, fn, { nameSanitizer: safeKeywordName })) as {
+    (name: NodeName): FuncPyDsl;
+    (name: NodeName, fn: (f: FuncPyDsl) => void): FuncPyDsl;
+  },
 
   /** Creates a negation expression (`-x`). */
   // neg: (...args: ConstructorParameters<typeof PrefixTsDsl>) => new PrefixTsDsl(...args).neg(),

packages/openapi-python/src/py-dsl/utils/name.ts

@@ -51,3 +51,5 @@ const safeName = (name: string, reserved: ReservedList): string => {
 };
 
 export const safeRuntimeName = (name: string): string => safeName(name, reserved.runtime);
+
+export const safeKeywordName = (name: string): string => safeName(name, reserved.keywords);

packages/openapi-python/src/py-dsl/utils/reserved.ts

@@ -29,12 +29,18 @@ export class ReservedList {
 }
 
 const runtimeReserved = new ReservedList([...keywords.pythonKeywords, ...keywords.pythonBuiltins]);
+const keywordReserved = new ReservedList([...keywords.pythonKeywords]);
 
 /**
  * Reserved names for identifiers. These names will not be used
  * for variables, functions, classes, or other identifiers in generated code.
  */
 export const reserved = {
+  /**
+   * Reserved names for Python language keywords. These names are syntactically
+   * invalid as identifiers in any scope.
+   */
+  keywords: keywordReserved,
   /**
    * Reserved names for runtime identifiers. These names will not be used
    * for variables, functions, classes, or other runtime identifiers in