Skip to content

Add public API for type checkers #46

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

Merged
merged 2 commits into from
Oct 7, 2022
Merged

Add public API for type checkers #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77a93fc
Add `__all__`
alkatar21 Oct 7, 2022
b01e6d8
Merge branch 'realpython:main' into typed2
alkatar21 Oct 7, 2022
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

## [Unreleased]

### Added

- `__all__` to let type checkers know what is part of the public API. (by [@alkatar21](https://github.com/alkatar21) in [#46])

## [1.3.1] - 2022-10-06

### Added
Expand Down Expand Up @@ -73,3 +77,4 @@ Initial version of `codetiming`. Version 1.0.0 corresponds to the code in the tu
[#34]: https://github.com/realpython/codetiming/pull/34
[#35]: https://github.com/realpython/codetiming/pull/35
[#38]: https://github.com/realpython/codetiming/pull/38
[#46]: https://github.com/realpython/codetiming/pull/46
5 changes: 4 additions & 1 deletion codetiming/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@ def stuff():
"""

# Codetiming imports
from codetiming._timer import Timer, TimerError # noqa
from codetiming._timer import Timer, TimerError

# Use __all__ to let type checkers know what is part of the public API.
__all__ = ["Timer", "TimerError"]

# Versioning is handled by bump2version
__version__ = "1.3.1"