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

[BUG][PYTHON] fix setup.py when no paths are specified #20098

Conversation

loic-seguin
Copy link
Contributor

@loic-seguin loic-seguin commented Nov 13, 2024

This PR is related to this issue #20090.
Looping on {{#apis}} in the setup.mustache is not needed I think because we already have the infos at the root level.
As a consequence the setup method is always present if no paths attribute is given inside the yaml.

TODO : We might need to do this also for the generator python-pydantic-v1...

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
  • Mentioning @cbornet @tomplus @krjakbrjak @fa0311 @multani

@loic-seguin loic-seguin changed the title bugfix/generate_correct_setup_py_when_no_apis [BUG][PYTHON] fix setup.py when no paths are specified Nov 13, 2024
@loic-seguin loic-seguin force-pushed the bugfix/generate_correct_setup_py_when_no_apis branch from 2020d96 to 76317df Compare November 13, 2024 19:48
@wing328
Copy link
Member

wing328 commented Nov 14, 2024

https://github.com/OpenAPITools/openapi-generator/actions/runs/11824698634/job/32968636666?pr=20098n

thanks for the PR. please follow step 3 to update the samples

@loic-seguin loic-seguin force-pushed the bugfix/generate_correct_setup_py_when_no_apis branch from 76317df to e3200c1 Compare November 14, 2024 09:12
@loic-seguin
Copy link
Contributor Author

https://github.com/OpenAPITools/openapi-generator/actions/runs/11824698634/job/32968636666?pr=20098n

thanks for the PR. please follow step 3 to update the samples

Done ;)

@loic-seguin loic-seguin force-pushed the bugfix/generate_correct_setup_py_when_no_apis branch from e3200c1 to d5b1146 Compare November 14, 2024 15:35
@wing328
Copy link
Member

wing328 commented Nov 26, 2024

Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

@wing328 wing328 added this to the 7.11.0 milestone Nov 26, 2024
@loic-seguin loic-seguin force-pushed the bugfix/generate_correct_setup_py_when_no_apis branch 3 times, most recently from d75bfb9 to 8f21e91 Compare November 26, 2024 09:58
@loic-seguin loic-seguin force-pushed the bugfix/generate_correct_setup_py_when_no_apis branch from 8f21e91 to d582a6c Compare November 26, 2024 10:00
@loic-seguin
Copy link
Contributor Author

Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

done

@wing328
Copy link
Member

wing328 commented Nov 30, 2024

@loic-seguin can you please review the build failure when you've time?

@loic-seguin
Copy link
Contributor Author

will do

@loic-seguin
Copy link
Contributor Author

loic-seguin commented Dec 15, 2024

Hello, hmmm I rebased and I did these steps :

./mvnw clean package
./bin/generate-samples.sh ./bin/configs/*.yaml
cd samples/openapi3/client/petstore/python
docker pull swaggerapi/petstore
docker run -d -e SWAGGER_HOST=http://petstore.swagger.io -e SWAGGER_BASE_PATH=/v2 -p 80:8080 swaggerapi/petstore
poetry run pytest -v

And I get => 289 passed, 3 skipped, 18 warnings in 9.83s.

And the tests that were not passing on the CI are apparently passing on my local now.
Maybe you could give approval to give it a try.

@wing328
Copy link
Member

wing328 commented Dec 17, 2024

trigger tests via #20339 instead

let's see how that goes

@wing328
Copy link
Member

wing328 commented Dec 17, 2024

all tests passed.

tested locally and found the following diff against the master:

diff --git a/setup.py b/setup.py
index 22a42d0..e56366b 100644
--- a/setup.py
+++ b/setup.py
@@ -23,27 +23,3 @@ from setuptools import setup, find_packages  # noqa: H301
 NAME = "openapi-client"
 VERSION = "1.0.0"
 PYTHON_REQUIRES = ">= 3.8"
-REQUIRES = [
-    "urllib3 >= 1.25.3, < 3.0.0",
-    "python-dateutil >= 2.8.2",
-    "pydantic >= 2",
-    "typing-extensions >= 4.7.1",
-]
-
-setup(
-    name=NAME,
-    version=VERSION,
-    description="Example Hello API",
-    author="OpenAPI Generator community",
-    author_email="[email protected]",
-    url="",
-    keywords=["OpenAPI", "OpenAPI-Generator", "Example Hello API"],
-    install_requires=REQUIRES,
-    packages=find_packages(exclude=["test", "tests"]),
-    include_package_data=True,
-    long_description_content_type='text/markdown',
-    long_description="""\
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
-    """,  # noqa: E501
-    package_data={"openapi_client": ["py.typed"]},
-)
\ No newline at end of file

which confirms the fix

thanks again for the PR

@wing328 wing328 merged commit b01c8be into OpenAPITools:master Dec 17, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants