Skip to content
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

Jump to bottom

add type annotations #1107

Merged
merged 94 commits into from
Jan 16, 2024
Merged

add type annotations #1107

merged 94 commits into from
Jan 16, 2024

Conversation

gboeing
Copy link
Owner

@gboeing gboeing commented Jan 11, 2024 •
edited
Loading

This PR adds complete type annotations throughout the package (validated via mypy . --strict and typeguard in CI) for user type hinting and type checking. It also fixes minor bugs and inconsistencies revealed by the subsequent type check validation. Resolves #1062.

This PR includes the following enhancements:

  • adds type annotations to all public and private functions
  • adds mypy strict validation to CI
  • adds typeguard runtime validation to CI
  • maintains test coverage
  • fix bug where _downloader._save_to_cache function expected requests.response.ok bool values as an argument, but was being passed requests.response.status_code int values instead
  • minor fixes throughout to address inconsistencies revealed by mypy static checking and typeguard runtime checking

See also #1106

@gboeing
update mypy config
14d1d40
@gboeing
add type annotations
9a429ef
@gboeing
update mypy config
d467bd7
@gboeing
add type annotations
8369e09
@gboeing
formatting
8a02787
@gboeing
update mypy config
98f3db7
@gboeing
add type annotations to utils_geo module
b583c8b
@gboeing
ignore deprecated function
da958f5
@gboeing
remove nx types that are causing trouble
bc60bb5
@gboeing
add type annotations to utils_graph module
118fa20
@gboeing
use future annotations to replace old Union with modern pipe syntax
2b37d15
@gboeing
require python 3.9+ for typing
cb0a773
@gboeing
add type annotations and make var names unique
f4ecea4
@gboeing
add overloads for graph_to_gdfs
ed755a7
@gboeing
add type hints to stats module
a50ab05
@gboeing
add type hints to speed module
f1dc43a
@gboeing
update mypy config
6db9bb9
@gboeing
add type hints to simplification module
d630f90
@gboeing
add type hints to routing module
b0b4fa8
@gboeing
add type hints to projection module
217e85c
@gboeing
add type hints to _downloader module
155b7d6
@gboeing
add type hints to _nominatim module
3e77e27
@gboeing
add type hints to _overpass module
4c0cb97
@gboeing
fix var type
98c893b
@gboeing
add type hints to bearing module
df601b6
@gboeing
ignore untyped defs in deprecated modules
a48de37
@gboeing
add type hints to geocoder module
17c657f
@gboeing
make type more-flexible iterable instead of list
a095ba2
@gboeing
add type hints to distance module
60d71e4
@gboeing
add type hints to elevation module
3a8a698
gboeing and others added 25 commits January 11, 2024 11:59
@gboeing
narrow types
21c2376
@gboeing
use type iterable instead of sequence where possible
3ffdd61
@gboeing
deprecate return_hex param
c52c712
@gboeing
fix type annotations
69e0597
@gboeing
ensure utils_graph receives GeoDataFrame type
b67aef0
@gboeing
fix type annotations and inconsistencies via runtime testing
0a03811
@gboeing
add typeguard
73fe1d4
@gboeing
replace hasattr(__iter__) with isinstance(Iterable)
58ff865
@gboeing
fix type:ignore[assignment] skips
dfc4ef3
@gboeing
remove unnecessary duplicative type annotations
2242ce4
@gboeing
fix typo
82337bc
@gboeing
simplify save_graph_xml arg types
6455ca2
@gboeing
Merge branch 'typing' of https://github.com/gboeing/osmnx into typing
2af97ef
@gboeing
Merge branch 'v2' into typing
1a5974d
@gboeing
fix tests
ff1e588
@gboeing
fix geocoder
57447de
@gboeing
skip link checks
3dd890e
@gboeing
add tests
35af461
@gboeing
improve error raising
2785129
@gboeing
no coverage for function typing overloads
e58eed7
@gboeing
fix coverage upload
4ab170d
@gboeing
improve test coverage
2228314
@gboeing
update ci config
d693181
@gboeing
update config
32bff74
@gboeing
make api_version str and change order of encoding param
19ac164
@gboeing gboeing merged commit 8113342 into v2 Jan 16, 2024
7 checks passed
@gboeing gboeing deleted the typing branch January 16, 2024 21:12
@gboeing
Copy link
Owner Author

gboeing commented May 3, 2024

The first pre-release OSMnx v2 beta has been released. Testers needed! See #1123 for details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@gboeing