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

Read description field from setup files #8545

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Assert description field in existing test cases
  • Loading branch information
ento authored and radoering committed Oct 17, 2023
commit c476b5e1b8b9018914e57f83f61a43cc6abdff2e
1 change: 1 addition & 0 deletions tests/utils/fixtures/setups/with-setup-cfg/setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[metadata]
name = with-setup-cfg
version = 1.2.3
description = Package with setup.cfg

[options]
zip_safe = true
Expand Down
16 changes: 16 additions & 0 deletions tests/utils/test_setup_reader.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ def test_setup_reader_read_first_level_setup_call_with_direct_types(

expected_name = "Flask"
expected_version = None
expected_description = "A simple framework for building complex web applications."
expected_install_requires = [
"Werkzeug>=0.14",
"Jinja2>=2.10",
Expand All @@ -51,6 +52,7 @@ def test_setup_reader_read_first_level_setup_call_with_direct_types(

assert result["name"] == expected_name
assert result["version"] == expected_version
assert result["description"] == expected_description
assert result["install_requires"] == expected_install_requires
assert result["extras_require"] == expected_extras_require
assert result["python_requires"] == expected_python_requires
Expand All @@ -63,6 +65,7 @@ def test_setup_reader_read_first_level_setup_call_with_variables(

expected_name = None
expected_version = None
expected_description = None
expected_install_requires = [
"chardet>=3.0.2,<3.1.0",
"idna>=2.5,<2.8",
Expand All @@ -78,6 +81,7 @@ def test_setup_reader_read_first_level_setup_call_with_variables(

assert result["name"] == expected_name
assert result["version"] == expected_version
assert result["description"] == expected_description
assert result["install_requires"] == expected_install_requires
assert result["extras_require"] == expected_extras_require
assert result["python_requires"] == expected_python_requires
Expand All @@ -90,6 +94,7 @@ def test_setup_reader_read_sub_level_setup_call_with_direct_types(

expected_name = "SQLAlchemy"
expected_version = None
expected_description = "Database Abstraction Library"
expected_install_requires: list[str] = []
expected_extras_require = {
"mysql": ["mysqlclient"],
Expand All @@ -104,6 +109,7 @@ def test_setup_reader_read_sub_level_setup_call_with_direct_types(

assert result["name"] == expected_name
assert result["version"] == expected_version
assert result["description"] == expected_description
assert result["install_requires"] == expected_install_requires
assert result["extras_require"] == expected_extras_require
assert result["python_requires"] is None
Expand All @@ -114,6 +120,7 @@ def test_setup_reader_read_setup_cfg(setup: Callable[[str], Path]) -> None:

expected_name = "with-setup-cfg"
expected_version = "1.2.3"
expected_description = "Package with setup.cfg"
expected_install_requires = ["six", "tomlkit"]
expected_extras_require = {
"validation": ["cerberus"],
Expand All @@ -123,6 +130,7 @@ def test_setup_reader_read_setup_cfg(setup: Callable[[str], Path]) -> None:

assert result["name"] == expected_name
assert result["version"] == expected_version
assert result["description"] == expected_description
assert result["install_requires"] == expected_install_requires
assert result["extras_require"] == expected_extras_require
assert result["python_requires"] == expected_python_requires
Expand All @@ -138,12 +146,14 @@ def test_setup_reader_read_setup_kwargs(setup: Callable[[str], Path]) -> None:

expected_name = "pendulum"
expected_version = "2.0.4"
expected_description = "Python datetimes made easy"
expected_install_requires = ["python-dateutil>=2.6,<3.0", "pytzdata>=2018.3"]
expected_extras_require = {':python_version < "3.5"': ["typing>=3.6,<4.0"]}
expected_python_requires = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*"

assert result["name"] == expected_name
assert result["version"] == expected_version
assert result["description"] == expected_description
assert result["install_requires"] == expected_install_requires
assert result["extras_require"] == expected_extras_require
assert result["python_requires"] == expected_python_requires
Expand All @@ -154,12 +164,14 @@ def test_setup_reader_read_setup_call_in_main(setup: Callable[[str], Path]) -> N

expected_name = "PyYAML"
expected_version = "3.13"
expected_description = "YAML parser and emitter for Python"
expected_install_requires: list[str] = []
expected_extras_require: dict[str, list[str]] = {}
expected_python_requires = None

assert result["name"] == expected_name
assert result["version"] == expected_version
assert result["description"] == expected_description
assert result["install_requires"] == expected_install_requires
assert result["extras_require"] == expected_extras_require
assert result["python_requires"] == expected_python_requires
Expand All @@ -172,12 +184,14 @@ def test_setup_reader_read_extras_require_with_variables(

expected_name = "extras_require_with_vars"
expected_version = "0.0.1"
expected_description = "test setup_reader.py"
expected_install_requires: list[str] = []
expected_extras_require = {"test": ["pytest"]}
expected_python_requires = None

assert result["name"] == expected_name
assert result["version"] == expected_version
assert result["description"] == expected_description
assert result["install_requires"] == expected_install_requires
assert result["extras_require"] == expected_extras_require
assert result["python_requires"] == expected_python_requires
Expand All @@ -188,6 +202,8 @@ def test_setup_reader_setuptools(setup: Callable[[str], Path]) -> None:

expected_name = "my_package"
expected_version = "0.1.2"
expected_description = "Just a description"

assert result["name"] == expected_name
assert result["version"] == expected_version
assert result["description"] == expected_description