René's URL Explorer Experiment


Title: bug: `filters: []` not usable when `group_by_category` is set to `false` · Issue #324 · mkdocstrings/python · GitHub

Open Graph Title: bug: `filters: []` not usable when `group_by_category` is set to `false` · Issue #324 · mkdocstrings/python

X Title: bug: `filters: []` not usable when `group_by_category` is set to `false` · Issue #324 · mkdocstrings/python

Description: To Reproduce Here is a simple module with a public and a protected function. def test(): """test.""" pass def _test(): """_test.""" pass Other options can be set to default values as follows. plugins: - mkdocstrings: default_handler: pyt...

Open Graph Description: To Reproduce Here is a simple module with a public and a protected function. def test(): """test.""" pass def _test(): """_test.""" pass Other options can be set to default values as follows. plugi...

X Description: To Reproduce Here is a simple module with a public and a protected function. def test(): """test.""" pass def _test(): """_test.""" pass ...

Opengraph URL: https://github.com/mkdocstrings/python/issues/324

X: @github

direct link

Domain: redirect.github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"bug: `filters: []` not usable when `group_by_category` is set to `false`","articleBody":"### To Reproduce\nHere is a simple module with a public and a protected function.\n```\ndef test():\n    \"\"\"test.\"\"\"\n    pass\n\ndef _test():\n    \"\"\"_test.\"\"\"\n    pass\n```\n\nOther options can be set to default values as follows.\n```yaml\nplugins:\n  - mkdocstrings:\n      default_handler: python\n      handlers:\n        python:\n          options:\n            group_by_category: false\n            filters: []\n```\n\nThen, the `_test()` method is not appeared in the generated document.\n\n### Full traceback\n\u003cdetails>\u003csummary>Full traceback\u003c/summary>\n\n```python\nDEBUG   -  mkdocstrings_handlers: python\\templates\\material\\function.html.jinja: Rendering mod.test.test\nDEBUG   -  mkdocstrings_handlers: python\\templates\\material\\signature.html.jinja: Rendering signature\nDEBUG   -  mkdocstrings_handlers: python\\templates\\material\\docstring.html.jinja: Rendering docstring\n\n# the following lines won't appear if `group_by_category` is set to `false`\nDEBUG   -  mkdocstrings_handlers: python\\templates\\material\\function.html.jinja: Rendering mod.test._test\nDEBUG   -  mkdocstrings_handlers: python\\templates\\material\\signature.html.jinja: Rendering signature\nDEBUG   -  mkdocstrings_handlers: python\\templates\\material\\docstring.html.jinja: Rendering docstring\n```\n\n\u003c/details>\n\n### Expected behavior\n\u003c!-- Please provide a clear and concise description of what you expected to happen. -->\n\n### Environment information\n- __System__: Windows 10\n- __Python__: cpython 3.10.11\n- __Environment variables__:\n- __Installed packages__:\n  - `mkdocstrings-python` v2.0.0\n\n### Additional context\nI have tried to pinpoint the issue in `children.html.jinja`, and find the following lines:\n```python\n{% if config.group_by_category %}\n... irrelevant codes here ...\n    {% else %}\n\n      {% for child in obj.all_members\n          |filter_objects(\n            filters=config.filters,\n            members_list=members_list,\n            inherited_members=config.inherited_members,\n            keep_no_docstrings=config.show_if_no_docstring,\n            )\n          |order_members(config.members_order, members_list)\n        %}\n\n        {% if not (obj.is_class and child.name == \"__init__\" and config.merge_init_into_class) %}\n\n          {% if config.filters == \"public\" or members_list is not none or child.is_public %}\n          ... rendering codes here ...\n          {% endif %}\n\n        {% endif %}\n\n      {% endfor %}\n\n    {% endif %}\n```\n\nI validate the filtering part, and the results are correct, so the problem may be inside the rendering part. Comparing with the similar codes in the `if`-branch, there is a significant difference in the code:\n```python\n{% if config.filters == \"public\" or members_list is not none or (not child.is_imported or child.is_public) %}\n```\n\nAfter adding these lines, the problem will be resolved on my device.","author":{"url":"https://github.com/T0nyX1ang","@type":"Person","name":"T0nyX1ang"},"datePublished":"2025-12-03T09:56:23Z","url":"https://github.com/mkdocstrings/python/issues/324"}

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react-reconciler,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@d5750093facf
route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:cd823d46-e523-1c37-a075-ae1f5fcdb3fc
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-id87EA:2B40B8:555D52:7709C6:6AF857E8
html-safe-nonce56e89a3633f4ef51145c315ab970f217448c7a2fdf1a632cbbb01e3d5d907cc7
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4N0VBOjJCNDBCODo1NTVENTI6NzcwOUM2OjZBRjg1N0U4IiwidmlzaXRvcl9pZCI6Ijc5ODE4ODIwOTM1ODEzOTE4NDgiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac613c3a2d9b6af851b7e462a1d50aa943d5daed9db2854f69afa2a8859c7b2338
hovercard-subject-tagissue:3689417943
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/mkdocstrings/python/324/issue_layout
twitter:imagehttps://opengraph.githubassets.com/c7b2e4de4cb50b92c6c149b0526f464eb84aa81478d2d38a702b71c379feae7b/mkdocstrings/python/issues/324
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/c7b2e4de4cb50b92c6c149b0526f464eb84aa81478d2d38a702b71c379feae7b/mkdocstrings/python/issues/324
og:image:altTo Reproduce Here is a simple module with a public and a protected function. def test(): """test.""" pass def _test(): """_test.""" pass Other options can be set to default values as follows. plugi...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameT0nyX1ang
hostnamegithub.com
expected-hostnamegithub.com
None5713ecd83001b2f55c3509fb7a292bf7d66d0f167c7ae87a9f7eaec5a52bf8db
turbo-cache-controlno-preview
go-importgithub.com/mkdocstrings/python git https://github.com/mkdocstrings/python.git
octolytics-dimension-user_id75664361
octolytics-dimension-user_loginmkdocstrings
octolytics-dimension-repository_id422878404
octolytics-dimension-repository_nwomkdocstrings/python
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id422878404
octolytics-dimension-repository_network_root_nwomkdocstrings/python
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release653be32ff5c755082a4db662491bfbbcfc9112c1
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://redirect.github.com/mkdocstrings/python/issues/324#start-of-content
https://redirect.github.com/
Sign inhttps://redirect.github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmkdocstrings%2Fpython%2Fissues%2F324
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://redirect.github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmkdocstrings%2Fpython%2Fissues%2F324
Sign uphttps://redirect.github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=mkdocstrings%2Fpython
Reloadhttps://redirect.github.com/mkdocstrings/python/issues/324
Reloadhttps://redirect.github.com/mkdocstrings/python/issues/324
Reloadhttps://redirect.github.com/mkdocstrings/python/issues/324
mkdocstringshttps://redirect.github.com/mkdocstrings
pythonhttps://redirect.github.com/mkdocstrings/python
Codehttps://redirect.github.com/mkdocstrings/python
Issues6 (6)https://redirect.github.com/mkdocstrings/python/issues
Pull requestshttps://redirect.github.com/mkdocstrings/python/pulls
Discussionshttps://redirect.github.com/mkdocstrings/python/discussions
Actionshttps://redirect.github.com/mkdocstrings/python/actions
Security and qualityhttps://redirect.github.com/mkdocstrings/python/security
Insightshttps://redirect.github.com/mkdocstrings/python/pulse
https://redirect.github.com/mkdocstrings/python
New issuehttps://redirect.github.com/login?return_to=https://github.com/mkdocstrings/python/issues/324
New issuehttps://redirect.github.com/login?return_to=https://github.com/mkdocstrings/python/issues/324
bug: filters: [] not usable when group_by_category is set to falsehttps://redirect.github.com/mkdocstrings/python/issues/324#top
https://redirect.github.com/pawamoy
bugSomething isn't workinghttps://github.com/mkdocstrings/python/issues?q=state%3Aopen%20label%3A%22bug%22
https://github.com/T0nyX1ang
T0nyX1anghttps://github.com/T0nyX1ang
on Dec 3, 2025https://github.com/mkdocstrings/python/issues/324#issue-3689417943
T0nyX1anghttps://redirect.github.com/T0nyX1ang
pawamoyhttps://redirect.github.com/pawamoy
on Dec 3, 2025https://github.com/mkdocstrings/python/issues/324#event-21328131305
T0nyX1anghttps://redirect.github.com/T0nyX1ang
unconfirmedThis bug was not reproduced yethttps://redirect.github.com/mkdocstrings/python/issues?q=state%3Aopen%20label%3A%22unconfirmed%22
on Dec 3, 2025https://github.com/mkdocstrings/python/issues/324#event-21328131829
https://redirect.github.com/pawamoy
pawamoyhttps://redirect.github.com/pawamoy
on Dec 3, 2025https://github.com/mkdocstrings/python/issues/324#issuecomment-3606361997
@T0nyX1anghttps://github.com/T0nyX1ang
pawamoyhttps://redirect.github.com/pawamoy
bugSomething isn't workinghttps://redirect.github.com/mkdocstrings/python/issues?q=state%3Aopen%20label%3A%22bug%22
unconfirmedThis bug was not reproduced yethttps://redirect.github.com/mkdocstrings/python/issues?q=state%3Aopen%20label%3A%22unconfirmed%22
on Dec 3, 2025https://github.com/mkdocstrings/python/issues/324#event-21333718565
pawamoyhttps://redirect.github.com/pawamoy
on Dec 3, 2025https://github.com/mkdocstrings/python/issues/324#event-21334234906
fix: Don't ignore filters when category grouping is disabledhttps://github.com/mkdocstrings/python/commit/63aa1b0af0d14912ebf83a4e3c2cd0c7f2a19dae
63aa1b0https://github.com/mkdocstrings/python/commit/63aa1b0af0d14912ebf83a4e3c2cd0c7f2a19dae
pawamoyhttps://redirect.github.com/pawamoy
completedhttps://redirect.github.com/mkdocstrings/python/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
on Dec 3, 2025https://github.com/mkdocstrings/python/issues/324#event-21334253306
Sign up for freehttps://redirect.github.com/signup?return_to=https://github.com/mkdocstrings/python/issues/324
Sign in to commenthttps://redirect.github.com/login?return_to=https://github.com/mkdocstrings/python/issues/324
pawamoyhttps://redirect.github.com/pawamoy
bugSomething isn't workinghttps://github.com/mkdocstrings/python/issues?q=state%3Aopen%20label%3A%22bug%22
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.