Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Python multi namespace #5375

Open
wants to merge 59 commits into
base: main
Choose a base branch
from
Open

Python multi namespace #5375

wants to merge 59 commits into from

Conversation

msyyc
Copy link
Contributor

@msyyc msyyc commented Dec 16, 2024

For Azure/autorest.python#2795.

Compared to the previous logic that only supported a single namespace, this PR introduces support for multiple namespaces. This primarily requires updates in two key areas:

  1. Serialization approach: We need to account for all namespaces and serialize them individually.
  2. Relative imports: The Python SDK utilizes relative imports internally, and we can no longer make assumptions about the location of models/operations. To determine the correct relative import, we need to know the serialized namespace within the imports function.

Considering these two main changes, here's a detailed summary of the updates in this PR:

  1. Added the emitter flag enable-typespec-namespace, which lets users decide if they want to support native typespec namespace.
  2. Introduced clientNamespace for models/operations/enums/namedUnions/clients: the emitter uses clientNamespace to determine the exact location where the target type should be.
  3. Created get_relative_import_path for CodeModel: all relative import paths should be calculated using this function.
  4. Added a new property client_namespace_types to CodeModel: it counts and stores all namespace types and information about clients/operation_groups/enums/models in each namespace.
  5. Serialization: With the new client_namespace_types property in CodeModel, we can cycle through each namespace and serialize its clients/models/enums/operations using the same logic.
  6. Imports: The old import logic used the relative_path and operation kwargs, which were not set from the top caller but from various functions during the calling process. The signatures were difficult to understand and maintain. I replaces them with the new serialize_namespace and serialize_namespace_type kwargs. Now, any function that needs to calculate relative imports can use these two parameters, which are set from the top caller, making them easier to understand and maintain.

@microsoft-github-policy-service microsoft-github-policy-service bot added the emitter:client:python Issue for the Python client emitter: @typespec/http-client-python label Dec 16, 2024
@azure-sdk
Copy link
Collaborator

No changes needing a change description found.

@azure-sdk
Copy link
Collaborator

You can try these changes here

🛝 Playground 🌐 Website 📚 Next docs

@@ -300,9 +302,15 @@ def imports(self, async_mode: bool) -> FileImport:
ImportType.SDKCORE,
TypingSection.CONDITIONAL,
)
serialize_namespace = kwargs.get("serialize_namespace", self.code_model.namespace)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to me, the relative import path is always calculated by the self namespace and the the namespace of the type imported. why we need this serialize_namespace arg?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

models can be imported in clients/models/operations so serialize_namespace is used to make sure where it is serialized.

Comment on lines 109 to 117
def get_relative_import_path(
self,
serialize_namespace: str,
imported_namespace: Optional[str] = None,
*,
imported_namespace_type: NamespaceType = NamespaceType.CLIENT,
async_mode: bool = False,
filename: str = "",
module_name: Optional[str] = None,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we make this calculation much simple? just calculate a import namespace based on current namespace? do not do different kinds of concat in this function which make it not so responsibility independent.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most of signatures are used to calculate real imported_namespace inner SDK so I am fine to split it into independent function.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
emitter:client:python Issue for the Python client emitter: @typespec/http-client-python
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants