swagger-codegen icon indicating copy to clipboard operation
swagger-codegen copied to clipboard

Use relative imports in generated Python packages

Open twosigmajab opened this issue 6 years ago • 5 comments

Description

Internally, generated Python code uses absolute imports that hard-code the assumption that users have the package installed top-level with a name like "swagger_server". For example, the following line results in the code from swagger_server import util being generated:

https://github.com/swagger-api/swagger-codegen/blob/62b93fc/modules/swagger-codegen/src/main/resources/flaskConnexion/controller.mustache#L6

This prevents users from putting the code in a directory with a more semantic name of their choosing, such as "gensrc".

If the generated code instead used relative imports, e.g. from .. import util in this case, then users would be free to move the code into a directory with a name of their choosing, or even nested in a subdirectory so they could import it as from gensrc.swagger_server import util, and then all the generated code's internal imports would still work.

Swagger-codegen version

Using 2.3.1 but believe this occurs in all versions, not a regression.

Steps to reproduce
swagger-codegen --input-spec api.yml \
    --output ./desired/subdirectory/on/my/python/path \
    --lang python-flask
Related issues/PRs

Only found it mentioned in a comment on a different PR ("change to the name will not fix the problem unfortunately, we need those relative imports"): https://github.com/swagger-api/swagger-codegen/pull/6839#discussion_r154770878

Suggest a fix/enhancement

Use relative imports.

twosigmajab avatar Sep 25 '18 14:09 twosigmajab