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

feat: Reorganize codegen and generated API files #2767

Merged
merged 14 commits into from
May 2, 2024
Merged

feat: Reorganize codegen and generated API files #2767

merged 14 commits into from
May 2, 2024

Conversation

mkundu1
Copy link
Contributor

@mkundu1 mkundu1 commented May 1, 2024

  1. The codegen module is moved to src/ansys/fluent/core so that it is packaged. A helper script is added at codegen/allapigen.py for users.
  2. All API files will be generated under a single directory, src/ansys/fluent/core/generated for PyFluent. This is to make packaging of the API files in Fluent side easier. I think this is okay as users won't directly import these files. The generated API directory is controlled through a module level variable which will be overwritten in Fluent side.

This PR contains the high level changes of the source and packaging structure. The goal is to package the codegen module and use it in Fluent to generate the API files at some Fluent packaging path. There will be additional PRs to refactor the codegen code to use Fluent's local static info. We shall also create a zipped module for settings API files to include in Fluent package (not for PyFluent ATM as the expanded directory is useful as the .pyi files are read by intellisense).

@mkundu1 mkundu1 linked an issue May 1, 2024 that may be closed by this pull request
@mkundu1 mkundu1 changed the title Re-organize codegen and generated API files feat: Re-organize codegen and generated API files May 1, 2024
@mkundu1 mkundu1 changed the title feat: Re-organize codegen and generated API files feat: Reorganize codegen and generated API files May 1, 2024
src/ansys/fluent/core/__init__.py Show resolved Hide resolved
@mkundu1 mkundu1 merged commit 8b253c1 into main May 2, 2024
26 checks passed
@mkundu1 mkundu1 deleted the feat/codegen branch May 2, 2024 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generating Python API files for settings API during Fluent compilation
6 participants