Add get_by_comment method to NumberedObjectCollection by digvijay-y · Pull Request #1006 · idaholab/MontePy

digvijay-y · 2026-08-10T17:02:58Z

Pull Request Checklist for MontePy

Description

Add get_by_comment method to NumberedObjectCollection
Implemented a method to yield objects matching a comment string or regex pattern.
Added unit tests to validate functionality and error handling for the new method.

Fixes #982

General Checklist

I have performed a self-review of my own code.
The code follows the standards outlined in the development documentation.
I have formatted my code with black version 25 or 26.
I have added tests that prove my fix is effective or that my feature works (if applicable).

LLM Disclosure

Are you?
- A human user
- A large language model (LLM), including ones acting on behalf of a human
Were any large language models (LLM or "AI") used in to generate any of this code?

Yes
- Model(s) used:
No

Documentation Checklist

I have documented all added classes and methods.
I have added type hints to all functions as needed.
I have marked all changes with the .. versionchanged:: or .. versionadded:: directives.

Infrastructure Changes

For infrastructure updates, I have updated the developer's guide.

Significant features or Behavior changes

For significant new features, I have added a section to the getting started guide.

First-Time Contributor Checklist

If this is your first contribution, add yourself to pyproject.toml if you wish to do so.

Additional Notes for Reviewers

Ensure that:

This PR fully addresses and resolves the referenced issue(s).
The submitted code is consistent with the merge checklist outlined here.
The PR covers all relevant aspects according to the development guidelines.
100% coverage of the patch is achieved, or justification for a variance is given.

📚 Documentation preview 📚: https://montepy--1006.org.readthedocs.build/en/1006/

…ng tests - Implemented a method to yield objects matching a comment string or regex pattern. - Added unit tests to validate functionality and error handling for the new method.

Signed-off-by: DIGVIJAY <144053736+digvijay-y@users.noreply.github.com>

MicahGale · 2026-09-18T15:02:39Z

The test failure isn't your fault, but could you fix it while you have a PR open? The problem is that setuptools-scm changed their website structure. Could you change: https://setuptools-scm.readthedocs.io/en/latest/ to https://setuptools-scm.readthedocs.io/latest/ in the documentation?

MicahGale

This is looking pretty good. Only that needs changed for sure is the changelog. Otherwise let's discuss the other concerns I had.

MicahGale · 2026-09-18T15:11:23Z

            cp_simple_problem.materials.check_number(-1)

+    def test_get_by_comment(self):
+        problem = montepy.read_input(os.path.join("tests", "inputs", "pin_cell.imcnp"))


Is there a reason to use this test case over the test.imcnp given by the fixture read_simple_problem? I haven't looked at how many comments there are recently.

@digvijay-y is there a reason you can't just the text fixture here?

…byte patterns

MicahGale

Looking good overall. Patch coverage looks to be 100%. Just need to resolve that broken link discussion from earlier, and the one question I had about the test case.

MicahGale

Just need to discuss if a test fixture could be used instead for the test.

digvijay-y · 2026-10-06T15:53:12Z

I can test with it and see how it works.

…

On Tue, 6 Oct, 2026, 21:21 Micah Gale, ***@***.***> wrote: ***@***.**** commented on this pull request. Just need to discuss if a test fixture could be used instead for the test. — Reply to this email directly, view it on GitHub <#1006?email_source=notifications&email_token=BCLBL2AGZ6SMDGOHKKIZPWT5SUIHNA5CNFSNUABKM5UWIORPF5TWS5BNNB2WEL2QOVWGYUTFOF2WK43UKJSXM2LFO4XTKNBTGEYDOMJWGYY2M4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJLDGN5XXIZLSL5RWY2LDNM#pullrequestreview-5431071661>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BCLBL2DCQ3VLWVE5QI6EGW35SUIHNAVCNFSNUABFKJSXA33TNF2G64TZHM3TIMJSGEYTGMBYHNEXG43VMU5TKMJRGI2TCOBUHE32C5QC> . You are receiving this because you were mentioned.Message ID: ***@***.***>

Copilot

🟡 Changes recommended

Required version metadata is missing from the affected public APIs.

1 open finding

Add versionadded directive for new public method · New

What changed in this PR

Adds comment-based lookup to NumberedObjectCollection, including literal and regex matching.

Changes:

Added get_by_comment.
Added text, regex, byte-regex, and error-handling tests.
Updated comment searching support and changelog documentation.

File	Reviewed changes
`tests/test_syntax_parsing.py`	Tests byte-regex behavior.
`tests/test_numbered_collection.py`	Tests comment-based lookup.
`montepy/numbered_object_collection.py`	Adds `get_by_comment`.
`montepy/comments.py`	Supports byte-compiled regexes.
`doc/source/dev_standards.rst`	Updates documentation links.
`doc/source/changelog.rst`	Records the new feature.

🧠 Review effort: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

+        """Yield all objects whose comments match the given text or pattern.
+
+        The search is applied to each object's


digvijay-y added 2 commits August 10, 2026 17:01

Add get_by_comment method to NumberedObjectCollection and correspondi…

d0e1e50

…ng tests - Implemented a method to yield objects matching a comment string or regex pattern. - Added unit tests to validate functionality and error handling for the new method.

Merge branch 'develop' into feat/search_by_comment

8150240

digvijay-y changed the title ~~Add get_by_comment method to NumberedObjectCollection and correspondi…~~ Add get_by_comment method to NumberedObjectCollection Sep 18, 2026

update: changelog

2976cad

Signed-off-by: DIGVIJAY <144053736+digvijay-y@users.noreply.github.com>

digvijay-y marked this pull request as ready for review September 18, 2026 06:35

digvijay-y requested review from MicahGale and a lite review from Copilot and removed request for Copilot September 18, 2026 06:35

Copilot started reviewing on behalf of digvijay-y September 18, 2026 06:36

View session

MicahGale requested changes Sep 18, 2026

View reviewed changes

update changelog and enhance comment search functionality to support …

765a92c

…byte patterns

Copilot AI lite review requested due to automatic review settings September 25, 2026 13:53

Copilot started reviewing on behalf of digvijay-y September 25, 2026 13:54

View session

digvijay-y requested review from MicahGale and removed request for Copilot September 25, 2026 13:55

MicahGale reviewed Sep 28, 2026

View reviewed changes

fix: update link to setuptools scm documentation for accuracy

0caa165

digvijay-y requested review from MicahGale and a lite review from Copilot and removed request for Copilot September 30, 2026 05:45

MicahGale reviewed Oct 6, 2026

View reviewed changes

Merge branch 'develop' into feat/search_by_comment

574cbb2

Copilot AI lite review requested due to automatic review settings October 9, 2026 09:59

Copilot started reviewing on behalf of digvijay-y October 9, 2026 10:00

View session

Copilot AI reviewed Oct 9, 2026

View reviewed changes

Comment thread montepy/numbered_object_collection.py

Comment on lines +269 to +271

"""Yield all objects whose comments match the given text or pattern.

The search is applied to each object's

digvijay-y requested a review from MicahGale October 9, 2026 10:05

Navigation Menu

Repository navigation

Add get_by_comment method to NumberedObjectCollection - #1006

Add get_by_comment method to NumberedObjectCollection#1006
digvijay-y wants to merge 6 commits into
idaholab:developfrom
digvijay-y:feat/search_by_comment

digvijay-y commented Aug 10, 2026 •

edited by github-actions Bot

Loading

Uh oh!

MicahGale commented Sep 18, 2026

Uh oh!

MicahGale left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MicahGale Sep 18, 2026

Uh oh!

MicahGale Oct 1, 2026

Uh oh!

Uh oh!

MicahGale left a comment

Uh oh!

MicahGale left a comment

Uh oh!

digvijay-y commented Oct 6, 2026 via email

Uh oh!

Copilot AI left a comment

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		"""Yield all objects whose comments match the given text or pattern.

		The search is applied to each object's

Conversation

digvijay-y commented Aug 10, 2026 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Checklist for MontePy

Description

General Checklist

LLM Disclosure

Documentation Checklist

Infrastructure Changes

Significant features or Behavior changes

First-Time Contributor Checklist

Additional Notes for Reviewers

Uh oh!

MicahGale commented Sep 18, 2026

Uh oh!

MicahGale left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MicahGale Sep 18, 2026

Choose a reason for hiding this comment

Uh oh!

MicahGale Oct 1, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

MicahGale left a comment

Choose a reason for hiding this comment

Uh oh!

MicahGale left a comment

Choose a reason for hiding this comment

Uh oh!

digvijay-y commented Oct 6, 2026 via email

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

digvijay-y commented Aug 10, 2026 •

edited by github-actions Bot

Loading