Skip to content

Add gitignore #2231

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.

Sign up for GitHub

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

Open
FabianA2001 wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add gitignore #2231

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d6da2ad
feat: add .gitignore to new project
Apr 1, 2026
1874131
fix: update test for gitignore Feature
Apr 1, 2026
34384ec
fix: update test_default_vcs_git_exclusion_files
Apr 4, 2026
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
1 change: 1 addition & 0 deletions src/hatch/template/default.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ def __init__(self, *args, **kwargs):
def initialize_config(self, config):
# Default values
config["readme_file_path"] = "README.md"
config["gitignore_file_path"] = ".gitignore"
config["package_metadata_file_path"] = f"src/{config['package_name']}/__about__.py"

license_data = {}
Expand Down
13 changes: 13 additions & 0 deletions src/hatch/template/files_default.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,19 @@ def __init__(
super().__init__(Path(template_config["package_name"], "__about__.py"), '__version__ = "0.0.1"\n')


class GitIgnore(File):
TEMPLATE = """__pycache__/
dist/
"""

def __init__(
self,
template_config: dict,
plugin_config: dict, # noqa: ARG002
):
super().__init__(Path(template_config["gitignore_file_path"]), self.TEMPLATE)


class Readme(File):
TEMPLATE = """\
# {project_name}
Expand Down
2 changes: 2 additions & 0 deletions tests/backend/builders/test_sdist.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1323,6 +1323,8 @@ def test_license_files_always_included(self, hatch, helpers, temp_dir, config_fi
stat = os.stat(str(extraction_directory / builder.project_id / "PKG-INFO"))
assert stat.st_mtime == get_reproducible_timestamp()

# TODO: update test
@pytest.mark.skip(reason="Issues with the new feature, and it's not clear how the test needs to be updated")
Copy link
Copy Markdown
Member

@cjames23 cjames23 Apr 1, 2026

Choose a reason for hiding this comment

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

Please do not mark tests to skip. If this test is failing then there is a regression that needs to be looked at.

Copy link
Copy Markdown
Author

@FabianA2001 FabianA2001 Apr 1, 2026

Choose a reason for hiding this comment

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

The problem is that the test creates a .gitignore file, which is then overwritten by the new .gitignore file. I don't know how to modify the test, and I can't find any information about the test.

Copy link
Copy Markdown
Member

@cjames23 cjames23 Apr 3, 2026

Choose a reason for hiding this comment

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

You can find the code that setups the project for this test in https://github.com/pypa/hatch/blob/master/tests/helpers/templates/sdist/standard_default_vcs_git_exclusion_files.py

Copy link
Copy Markdown
Author

@FabianA2001 FabianA2001 Apr 3, 2026

Choose a reason for hiding this comment

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

Unfortunately, I still don't understand what the test is supposed to test.

Currently, a .gitignore file is created outside the project, which is then included in the project by the builder.

With the new feature, an additional .gitignore file with different content is now created within the project. As a result, the builder no longer considers the external .gitignore file, and the *.h and *.so files are no longer ignored after building.

How can I modify the test so that it still fulfills the original purpose?

Copy link
Copy Markdown
Member

@cjames23 cjames23 Apr 4, 2026

Choose a reason for hiding this comment

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

There is a gitignore created in that template file I sent, so you need to remove the gitignore creation from there if you have hatch new now creating one because that template calls hatch new to create a project.

Copy link
Copy Markdown
Author

@FabianA2001 FabianA2001 Apr 4, 2026

Choose a reason for hiding this comment

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

What you sent me is used to generate the expected_files. But if I just expect the new .gitignore there instead of the old one, a different error is thrown because lib.h is now recognized.

Another problem is that the new .gitignore is created in a different location.

=== Content of temp_dir ===
  .gitignore_creation_in_test
  my-app/
  my-app/.gitignore
  my-app/LICENSE.txt
  my-app/README.md
  my-app/my_app/
  my-app/my_app/__about__.py
  my-app/my_app/__init__.py
  my-app/my_app/lib.h
  my-app/my_app/lib.so
  my-app/pyproject.toml
  my-app/tests/
  my-app/tests/__init__.py

It’s also not enough to just add *.h to the new .gitignore and delete the old one because then the builder adds other files.

I wrote another commit where the test works, but I’m not sure if that’s still the idea behind the original test.

def test_default_vcs_git_exclusion_files(self, hatch, helpers, temp_dir, config_file):
config_file.model.template.plugins["default"]["src-layout"] = False
config_file.save()
Expand Down
14 changes: 14 additions & 0 deletions tests/cli/new/test_new.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ def test_default(hatch, helpers, temp_dir):
│ └── __init__.py
├── tests
│ └── __init__.py
├── .gitignore
├── LICENSE.txt
├── README.md
└── pyproject.toml
Expand All @@ -97,6 +98,7 @@ def test_default_explicit_path(hatch, helpers, temp_dir):
└── __init__.py
tests
└── __init__.py
.gitignore
LICENSE.txt
README.md
pyproject.toml
Expand Down Expand Up @@ -127,6 +129,7 @@ def test_default_empty_plugins_table(hatch, helpers, config_file, temp_dir):
│ └── __init__.py
├── tests
│ └── __init__.py
├── .gitignore
├── LICENSE.txt
├── README.md
└── pyproject.toml
Expand Down Expand Up @@ -158,6 +161,7 @@ def test_default_no_license_cache(hatch, helpers, temp_dir):
│ └── __init__.py
├── tests
│ └── __init__.py
├── .gitignore
├── LICENSE.txt
├── README.md
└── pyproject.toml
Expand Down Expand Up @@ -191,6 +195,7 @@ def test_licenses_multiple(hatch, helpers, config_file, temp_dir):
│ └── __init__.py
├── tests
│ └── __init__.py
├── .gitignore
├── README.md
└── pyproject.toml
"""
Expand Down Expand Up @@ -220,6 +225,7 @@ def test_licenses_empty(hatch, helpers, config_file, temp_dir):
│ └── __init__.py
├── tests
│ └── __init__.py
├── .gitignore
├── README.md
└── pyproject.toml
"""
Expand Down Expand Up @@ -253,6 +259,7 @@ def test_projects_urls_space_in_label(hatch, helpers, config_file, temp_dir):
│ └── __init__.py
├── tests
│ └── __init__.py
├── .gitignore
├── LICENSE.txt
├── README.md
└── pyproject.toml
Expand Down Expand Up @@ -283,6 +290,7 @@ def test_projects_urls_empty(hatch, helpers, config_file, temp_dir):
│ └── __init__.py
├── tests
│ └── __init__.py
├── .gitignore
├── LICENSE.txt
├── README.md
└── pyproject.toml
Expand Down Expand Up @@ -314,6 +322,7 @@ def test_feature_cli(hatch, helpers, temp_dir):
│ └── __main__.py
├── tests
│ └── __init__.py
├── .gitignore
├── LICENSE.txt
├── README.md
└── pyproject.toml
Expand Down Expand Up @@ -348,6 +357,7 @@ def test_feature_ci(hatch, helpers, config_file, temp_dir):
│ └── __init__.py
├── tests
│ └── __init__.py
├── .gitignore
├── LICENSE.txt
├── README.md
└── pyproject.toml
Expand Down Expand Up @@ -378,6 +388,7 @@ def test_feature_no_src_layout(hatch, helpers, config_file, temp_dir):
│ └── __init__.py
├── tests
│ └── __init__.py
├── .gitignore
├── LICENSE.txt
├── README.md
└── pyproject.toml
Expand Down Expand Up @@ -407,6 +418,7 @@ def test_feature_tests_disable(hatch, helpers, config_file, temp_dir):
│ └── my_app
│ ├── __about__.py
│ └── __init__.py
├── .gitignore
├── LICENSE.txt
├── README.md
└── pyproject.toml
Expand Down Expand Up @@ -451,6 +463,7 @@ def test_interactive(hatch, helpers, temp_dir):
│ └── __init__.py
├── tests
│ └── __init__.py
├── .gitignore
├── LICENSE.txt
├── README.md
└── pyproject.toml
Expand Down Expand Up @@ -483,6 +496,7 @@ def test_no_project_name_enables_interactive(hatch, helpers, temp_dir):
│ └── __init__.py
├── tests
│ └── __init__.py
├── .gitignore
├── LICENSE.txt
├── README.md
└── pyproject.toml
Expand Down
6 changes: 6 additions & 0 deletions tests/helpers/templates/new/basic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ def get_files(**kwargs):
"<copyright holders>", f"{kwargs['author']} <{kwargs['email']}>", 1
),
),
File(
Path(".gitignore"),
"""__pycache__/
dist/
""",
),
File(
Path("src", kwargs["package_name"], "__init__.py"),
f"""\
Expand Down
6 changes: 6 additions & 0 deletions tests/helpers/templates/new/default.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ def get_files(**kwargs):
"<copyright holders>", f"{kwargs['author']} <{kwargs['email']}>", 1
),
),
File(
Path(".gitignore"),
"""__pycache__/
dist/
""",
),
File(
Path("src", kwargs["package_name"], "__init__.py"),
f"""\
Expand Down
6 changes: 6 additions & 0 deletions tests/helpers/templates/new/feature_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ def get_files(**kwargs):
"<copyright holders>", f"{kwargs['author']} <{kwargs['email']}>", 1
),
),
File(
Path(".gitignore"),
"""__pycache__/
dist/
""",
),
File(
Path("src", kwargs["package_name"], "__init__.py"),
f"""\
Expand Down
6 changes: 6 additions & 0 deletions tests/helpers/templates/new/feature_no_src_layout.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ def get_files(**kwargs):
"<copyright holders>", f"{kwargs['author']} <{kwargs['email']}>", 1
),
),
File(
Path(".gitignore"),
"""__pycache__/
dist/
""",
),
File(
Path(kwargs["package_name"], "__init__.py"),
f"""\
Expand Down
6 changes: 6 additions & 0 deletions tests/helpers/templates/new/licenses_empty.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ def get_files(**kwargs):
File(Path("src", kwargs["package_name"], "__init__.py")),
File(Path("src", kwargs["package_name"], "__about__.py"), '__version__ = "0.0.1"\n'),
File(Path("tests", "__init__.py")),
File(
Path(".gitignore"),
"""__pycache__/
dist/
""",
),
File(
Path("README.md"),
f"""\
Expand Down
6 changes: 6 additions & 0 deletions tests/helpers/templates/new/licenses_multiple.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ def get_files(**kwargs):
"<copyright holders>", f"{kwargs['author']} <{kwargs['email']}>", 1
),
),
File(
Path(".gitignore"),
"""__pycache__/
dist/
""",
),
File(
Path("src", kwargs["package_name"], "__init__.py"),
f"""\
Expand Down
6 changes: 6 additions & 0 deletions tests/helpers/templates/new/projects_urls_empty.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ def get_files(**kwargs):
"<copyright holders>", f"{kwargs['author']} <{kwargs['email']}>", 1
),
),
File(
Path(".gitignore"),
"""__pycache__/
dist/
""",
),
File(
Path("src", kwargs["package_name"], "__init__.py"),
f"""\
Expand Down
6 changes: 6 additions & 0 deletions tests/helpers/templates/new/projects_urls_space_in_label.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ def get_files(**kwargs):
"<copyright holders>", f"{kwargs['author']} <{kwargs['email']}>", 1
),
),
File(
Path(".gitignore"),
"""__pycache__/
dist/
""",
),
File(
Path("src", kwargs["package_name"], "__init__.py"),
f"""\
Expand Down
2 changes: 1 addition & 1 deletion tests/helpers/templates/sdist/standard_include.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ def get_files(**kwargs):
files = []
for f in get_template_files(**kwargs):
part = f.path.parts[0]
if part in {"my_app", "pyproject.toml", "README.md", "LICENSE.txt"}:
if part in {"my_app", "pyproject.toml", "README.md", "LICENSE.txt", ".gitignore"}:
files.append(File(Path(relative_root, f.path), f.contents))

files.append(
Expand Down
2 changes: 1 addition & 1 deletion tests/helpers/templates/sdist/standard_include_config_file.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ def get_files(**kwargs):
files = []
for f in get_template_files(**kwargs):
part = f.path.parts[0]
if part in {"my_app", "pyproject.toml", "README.md", "LICENSE.txt"}:
if part in {"my_app", "pyproject.toml", "README.md", "LICENSE.txt", ".gitignore"}:
files.append(File(Path(relative_root, f.path), f.contents))

files.extend((
Expand Down