Skip to content

Prepare release v1.0.0 - #57

Merged
henri-hulski merged 15 commits into
masterfrom
prep_1.0.0
Sep 27, 2026
Merged

henri-hulski merged 15 commits into
masterfrom
prep_1.0.0

Conversation

@henri-hulski

Copy link
Copy Markdown
Member

@Daverball Can you take a look?

@coveralls

coveralls commented Sep 22, 2026 •

Copy link
Copy Markdown

Coverage Status

coverage: 100.0% (+5.1%) from 94.861% — prep_1.0.0 into master

@Daverball Daverball left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good to me apart from the pyright failures on the CI due to the missing sphinx dependency in that tox environment. mypy only seems to succeed because the mypy configuration currently still ignores errors in dectate.sphinxext, so it's not in sync with the pyright config that no longer excludes that module.

Comment thread pyproject.toml Outdated
Comment on lines 86 to 88
[[tool.mypy.overrides]]
module = "dectate.sphinxext.*"
ignore_errors = true

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This seems to be inconsistent with the pyright config, but pyright also currently fails to type check. I assume it's missing the sphinx dependency in that specific tox environment.

@henri-hulski
henri-hulski force-pushed the prep_1.0.0 branch 3 times, most recently from f84739c to 5dd5409 Compare September 22, 2026 21:34
@henri-hulski

henri-hulski commented Sep 22, 2026 •

Copy link
Copy Markdown
Member Author

I fixed also the scenarios folder. I was still using the old API before dectate 0.12.
Also removed now sphinxext ignore from mypy.

@henri-hulski
henri-hulski force-pushed the prep_1.0.0 branch 2 times, most recently from 0dea883 to 86139f5 Compare September 26, 2026 18:22
@Daverball

Daverball commented Sep 26, 2026 •

Copy link
Copy Markdown
Contributor

I'm not thrilled about the prospect of adding import-time overhead for some typing-only symbols only so the docs can cross reference them.

Maybe we build the docs with Python 3.15 and leverage the new lazy imports, like this:

if TYPE_CHECKING:
    from collections.abc import Callable, Sequence
elif sys.version_info >= (3, 15):
    __lazy_modules__ = ["collections.abc"]
    from collections.abc import Callable, Sequence

Or if we're fine with changing the annotations from Callable to abc.Callable we could write it like this:

if TYPE_CHECKING:
    from collections import abc
elif sys.version_info >= (3, 15):
   abc = __lazy_import__("collections.abc")

That would also let you deal with the symbols that currently lead to circular references, since sphinx won't inspect the annotations until the modules have fully loaded, so the lazy imports won't trigger until that happens.

@henri-hulski

Copy link
Copy Markdown
Member Author

I guess you're right. I will take a look.
Same for importscan. I did there some similar changes.

BTW I made the changes for importscan directly to the master branch. Would you prefer if I always create a PR so it's easier to review?

@Daverball

Copy link
Copy Markdown
Contributor

A PR definitely can't hurt if you want a second pair of eyes looking over the changes, but I'll leave it up to your judgement.

@henri-hulski

Copy link
Copy Markdown
Member Author

I added a doc-build-only shim add the end of doc/conf.py.
That should fix it.

@Daverball

Copy link
Copy Markdown
Contributor

That works too, yeah. Can't we use the same trick to resolve the circularity issue with Configurable in dectate.app?

@henri-hulski

Copy link
Copy Markdown
Member Author

Yep - I was able to fix Configurable in the same way.
importscan was a bit trickier. You can take a look at the last commit.

@henri-hulski
henri-hulski merged commit 52b015d into master Sep 27, 2026
13 checks passed
@henri-hulski
henri-hulski deleted the prep_1.0.0 branch September 27, 2026 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants