[beman-tidy] Implement DIRECTORY.INTERFACE_HEADERS check by vickgoodman · Pull Request #134 · bemanproject/beman-tidy

vickgoodman · 2025-07-15T13:31:55Z

Implement DIRECTORY.INTERFACE_HEADERS check - #43

Added check
Added tests

Add beman-tidy: The Codebase Bemanification Tool

- We no longer need Makefiles - No need for requirements.txt files, better lockfiles instead Signed-off-by: rishyak <hello@rishyak.com>

Signed-off-by: rishyak <hello@rishyak.com>

…alAction - `type` param of `argparse.BooleanOptionalAction` are deprecated and will be removed in Python 3.14 - https://docs.python.org/3.14/deprecations/pending-removal-in-3.14.html Signed-off-by: rishyak <hello@rishyak.com>

Authored-by: Darius Neațu <neautdarius@gmail.com>

- Move code under beman_tidy/ (including lib/) - This aligns with PyPA's recommended flat layout, and ensures your lib/ subpackage is bundled in the wheel. - See: https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/

beman-tidy: migrate to pyproject.toml-based build with Astral's uv

Exclude more build artifacts

[beman-tidy] tweaks in docs

…ly stored inside the beman_tidy/ subdirectory

…TRUNK_VERSION [beman-tidy] Implement RELEASE.*

…PERS

…ment-REPOSITORY.DISALLOW_GIT_SUBMODULES [beman-tidy] Implemented REPOSITORY.DISALLOW_GIT_SUBMODULES

…all, run_beman_tidy_on_exemplar

neatudarius · 2025-07-16T14:38:50Z

tools/beman-tidy/beman_tidy/lib/checks/beman_standard/directory.py

+        # Example path: "exemplar/include/beman/exemplar"
+        include_path = self.path / "include" / "beman" / self.repo_info["name"]
+        if (
+            not os.path.exists(include_path)


still not applied - we should not require using os if we are using Path

neatudarius · 2025-07-22T00:30:04Z

tools/beman-tidy/beman_tidy/lib/checks/beman_standard/directory.py


-# TODO DIRECTORY.INTERFACE_HEADERS
+@register_beman_standard_check("DIRECTORY.INTERFACE_HEADERS")
+class DirectoryInterfaceHeadersCheck(DirectoryBaseCheck):


You should not have include_path = self.path / "include" / "beman" / self.repo_info["name"] in your code!
This is why BemanTreeDirectoryCheck class exists. We should have class DirectoryInterfaceHeadersCheck(BemanTreeDirectoryCheck), which will give you self.path -> include/beman/short_name. And then you can create other paths, if you want starting from self.repo_path.

neatudarius · 2025-07-22T00:30:39Z

tools/beman-tidy/beman_tidy/lib/checks/beman_standard/directory.py

+        include_path = self.path / "include" / "beman" / self.repo_info["name"]
+        if (
+            not os.path.exists(include_path)
+            or os.path.isfile(include_path)


Suggested change

or os.path.isfile(include_path)

or os.path.isfile(include_path)

can we use pathlib instead os everywhere?

neatudarius · 2025-07-22T00:30:59Z

tools/beman-tidy/beman_tidy/lib/checks/beman_standard/directory.py

+            or len(os.listdir(include_path)) == 0
+        ):
+            self.log(
+                f"The path '{self.path}' does not exist, is a file or is empty."


Suggested change

f"The path '{self.path}' does not exist, is a file or is empty."

f"The path '{self.path}' does not exist, is a file or is empty. "

neatudarius · 2025-07-22T00:31:06Z

tools/beman-tidy/beman_tidy/lib/checks/beman_standard/directory.py

+        ):
+            self.log(
+                f"The path '{self.path}' does not exist, is a file or is empty."
+                " All public header files must reside within include/beman/<short_name>/."


Suggested change

" All public header files must reside within include/beman/<short_name>/."

"All public header files must reside within include/beman/<short_name>/."

neatudarius · 2025-07-22T00:32:47Z

tools/beman-tidy/beman_tidy/lib/checks/beman_standard/directory.py

+        if self.repo_info["name"] == "exemplar":
+            exclude_dirs.add("cookiecutter")
+
+        hpp_files = []


Suggested change

hpp_files = []

header_files = []

Please don't resolve comments , just push fixes and reply. I will marke comments as resolved e.g. https://github.com/bemanproject/infra/pull/134/files#r2207970309.

neatudarius · 2025-07-22T00:33:43Z

tools/beman-tidy/beman_tidy/lib/checks/beman_standard/directory.py

+        for hpp_file in hpp_files:
+            if not hpp_file.startswith(str(include_path)):
+                self.log(
+                    f"Header file '{hpp_file}' is not under include/beman/{self.repo_info['name']}/ directory."


Suggested change

f"Header file '{hpp_file}' is not under include/beman/{self.repo_info['name']}/ directory."

f"Header file '{hpp_file}' is not under include/beman/{self.repo_name}/ directory."

we have that shortcut - pleas read tools/beman-tidy/beman_tidy/lib/checks/base/base_check.py

…install-and-run-beman-tidy [beman-tidy] CI flows should test, build, install and run beman-tidy

…ch-8 [beman-tidy] CI tests should run on schedule and on demand.

…ch-9 Tweaks in docs

…DERS

…ment-DIRECTORY.DOCS [beman-tidy] implement DIRECTORY.DOCS

… fixed tests

…DERS

tools/beman-tidy/tests/lib/checks/beman_standard/directory/test_directory.py

neatudarius

temporary blocking this PR until we figured out what's desired plan and expectations for tidy and headers checks

neatudarius · 2025-07-23T12:00:06Z

tools/beman-tidy/beman_tidy/lib/checks/beman_standard/directory.py

+
+    def check(self):
+        """
+        Check that all public header files reside within the include/beman/<short_name>/ directory.


Again, let's not discussed implementation from this PR, as the pattern is similar to the one for PAPERS (https://github.com/bemanproject/infra/pull/159#discussion_r2223086644).

I propose a plan for DIRECTORY.INTERFACE_HEADERS and DIRECTORY.IMPLEMENTATION_HEADERS

@Valid header locations
First of all, we can have headers in

include/beman/<short_name> - valid location

include/ but not in include/beman/<short_name> - invalid location

src/beman/short_name - valid location

src but not in src/beman/short_name - invalid location

examples/ - valid location

tests/beman/short_name - valid location

tests/ but not in tests/beman/short_name - invalid location

cookiecutter - valid location

infra - valid location
TLDR:

valid_header_locations = [ # Library specific "include/beman/short_name", "src/beman/short_name", "tests/beman/short_name", 'examples", # Infra "infra", "cookiecutter", ]

We can assume, IMO, for now, that this is a complete set of locations which can be used in v1 implementation. If we go with this approach, we can actually run locally run the tool on all libraries and see if we are missing something before first commit!

@CML can provide us necessary info?

I briefly investigated if we can use CML. As per my understanding, CML does not export this info in compile_commands.json, so I think we should actually parse the CML and find the target_sources call and see what we set for PUBLIC and PRIVATE. @nickelpro ?

I don't want to complicate things - let's assume it works with CML. What if a library requires custom build flags to actually build with a (sub)directory? etc
I think it's better to do best-effort search by accessing the filesystem, IMO.

=================================================================
My proposal

I. Steps for DIRECTORY.INTERFACE_HEADERS:

We assert to exists include/beman/<short_name> (we cannot have a library without at least one public header!). If invalid, we stop -> Missing include/beman/<short_name>. Expected public interface to be present. Please check ....

We do search for all headers in the repo which are not in valid_header_locations , and if we find one we fail the check.

If 1 + 2 passed, DIRECTORY.INTERFACE_HEADERS check also passes.
(We actually just checked headers are at right location. We didn't use the "public" thing here. It's not needed IMO.)
TLDR: It's same proposal from this PR.

II. Steps for DIRECTORY.IMPLEMENTATION_HEADERS.
We cannot actually easier distinguish which is public and which is private headers. We can say it's SKIPPED and log a message (we assume my PR #148 is already merged).

=================================================================

Again, please ignore the current pushed implementation, let's decide what should be the desired approach.
CC: @vickgoodman (PR owner) @JeffGarland (Style Czar) @nickelpro (Build Czar)

Due to Victor's availability (PTO), we discussed and I may take this PR (we want DIRECTORY.*) to be completed for release 1.0 ASAP. @vickgoodman , can you confirm?

Feel free to update the PR and close the issue. Thanks!

I will update this PR next weeks.

neatudarius · 2025-08-11T15:20:38Z

Reminder to update this PR with latest main after https://github.com/bemanproject/infra/pull/170.

neatudarius · 2026-01-20T13:29:08Z

Reminder to update this PR with latest main after https://github.com/bemanproject/infra/pull/170.

@vickgoodman , reminder^ - the repo was renamed, the main history was changed.

Darius Neațu and others added 30 commits June 16, 2025 16:11

beman-tidy: rename CI job

fb86184

beman-tidy: remove impl for README.LIBRARY_STATUS

1dcbac2

beman-tidy: add more TODOs

5592d11

beman-tidy: tweaks in docs

d35f6de

Merge pull request #2 from neatudarius/beman-tidy

d52d22e

Add beman-tidy: The Codebase Bemanification Tool

beman-tidy: support for pyproject.toml and uv

1f4fda2

- We no longer need Makefiles - No need for requirements.txt files, better lockfiles instead Signed-off-by: rishyak <hello@rishyak.com>

beman-tidy: ruff linter tweaks (#1)

889aa13

docs(beman-tidy): uv-ify docs

006c318

Signed-off-by: rishyak <hello@rishyak.com>

fix: remove non-existent identifier

85c46d2

Signed-off-by: rishyak <hello@rishyak.com>

build: bump python

0059f30

Signed-off-by: rishyak <hello@rishyak.com>

build(deps): sync lockfiles

d04af1c

Signed-off-by: rishyak <hello@rishyak.com>

[beman-tidy] beman-tidy: improve docs and examples (#2)

1f569cb

[beman-tidy] beman-tidy: remove unused Python deps (bemanproject#3)

492c8ec

Authored-by: Darius Neațu <neautdarius@gmail.com>

chore(gitignore): add editor config files

82634fc

build: downgrade python version and sync deps

75964b0

docs(dev guide): update dependency management steps

c95e471

chore: rename main.py to cli.py

e27ae49

chore: add @rishyak to codeowners

b56e87e

Merge pull request bemanproject#31 from rishyak/rish.pep518

c13bc05

beman-tidy: migrate to pyproject.toml-based build with Astral's uv

[beman-tidy] exclude build artifacts

cc14485

Exclude more build artifacts

0e29ce9

Merge pull request bemanproject#34 from bemanproject/neatudarius-patch-4

2b33660

Exclude more build artifacts

beman-tidy: add check - README.LIBRARY_STATUS

ffc32a0

beman-tidy: tests/ subtree should mirror beman_tidy subtree

d869b65

beman-tidy: more tweaks in docs

a4530b1

Merge branch 'main' into beman-tidy-docs

cb7b3fa

[beman-tidy] docs: add explicit wording

819952f

Merge pull request bemanproject#36 from neatudarius/beman-tidy-docs

7041d9e

[beman-tidy] tweaks in docs

Darius Neațu and others added 10 commits July 20, 2025 02:07

[beman-tidy] Improve docs

aab8105

[beman-tidy] beman-tidy should access configuration files that are on…

cd5b2f9

…ly stored inside the beman_tidy/ subdirectory

Merge pull request bemanproject#143 from neatudarius/RELEASE.GODBOLT_…

b9045ba

…TRUNK_VERSION [beman-tidy] Implement RELEASE.*

[beman-tidy] Submodule path starts with 'papers/' as per DIRECTORY.PA…

fb89aba

…PERS

Merge pull request bemanproject#141 from vickgoodman/beman-tidy-imple…

f559bc6

…ment-REPOSITORY.DISALLOW_GIT_SUBMODULES [beman-tidy] Implemented REPOSITORY.DISALLOW_GIT_SUBMODULES

[beman-tidy] CI flows should build, install and run beman-tidy

ee35abf

[beman-tidy] Added check, fix and tests for DIRECTORY.DOCS

7fe0d69

[beman-tidy] Run linter

1f59595

[beman-tidy] Remove repo name assignment in path check

5b139db

[beman-tidy] CI flows: split in run_linter, run_tests, build_and_inst…

720727e

…all, run_beman_tidy_on_exemplar

neatudarius reviewed Jul 22, 2025

View reviewed changes

neatudarius and others added 13 commits July 22, 2025 08:34

Merge pull request bemanproject#150 from neatudarius/CI-should-build-…

54196af

…install-and-run-beman-tidy [beman-tidy] CI flows should test, build, install and run beman-tidy

[beman-tidy] CI tests should run on schedule and on demand.

7238db9

[beman-tidy] Set CI tests run schedule

c62e547

Merge pull request bemanproject#154 from bemanproject/neatudarius-pat…

9f57a6f

…ch-8 [beman-tidy] CI tests should run on schedule and on demand.

Tweaks in docs

b881291

Merge pull request bemanproject#158 from bemanproject/neatudarius-pat…

2a871ec

…ch-9 Tweaks in docs

Merge branch 'main' into beman-tidy-implement-DIRECTORY.DOCS

42f97ae

[beman-tidy] Minor changes to check and tests

3b54e6f

[beman-tidy] Run linter

f11a53c

Merge branch 'main' into beman-tidy-implement-DIRECTORY.INTERFACE_HEA…

20409da

…DERS

Merge pull request bemanproject#152 from vickgoodman/beman-tidy-imple…

93d6d77

…ment-DIRECTORY.DOCS [beman-tidy] implement DIRECTORY.DOCS

[beman-tidy] Improved check logic to be similar to DIRECTORY.DOCS and…

c2af8e9

… fixed tests

Merge branch 'main' into beman-tidy-implement-DIRECTORY.INTERFACE_HEA…

5b78f2b

…DERS

github-actions bot reviewed Jul 22, 2025

View reviewed changes

tools/beman-tidy/tests/lib/checks/beman_standard/directory/test_directory.py Outdated Show resolved Hide resolved

[beman-tidy] Run linter

fdd9ee1

neatudarius requested changes Jul 23, 2025

View reviewed changes

wusatosi force-pushed the main branch from 9762a5e to 964b91b Compare September 27, 2025 20:41

	or os.path.isfile(include_path)
	or os.path.isfile(include_path)

	f"The path '{self.path}' does not exist, is a file or is empty."
	f"The path '{self.path}' does not exist, is a file or is empty. "

	" All public header files must reside within include/beman/<short_name>/."
	"All public header files must reside within include/beman/<short_name>/."

	f"Header file '{hpp_file}' is not under include/beman/{self.repo_info['name']}/ directory."
	f"Header file '{hpp_file}' is not under include/beman/{self.repo_name}/ directory."

Conversation

vickgoodman commented Jul 15, 2025

Uh oh!

neatudarius Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

neatudarius left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

neatudarius commented Aug 11, 2025

Uh oh!

neatudarius commented Jan 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

neatudarius Jul 16, 2025 •

edited

Loading