Release 1.0.alpha.6

[cleder]

[watermelon-copilot-for-code-review]

WatermelonAI Summary

The 30 commits in this Pull Request suggest that the focus of the changes is on improving the data handling and type annotations. There are fixes for type errors in views, scaffold classes, and an implementation of an altitudeMode Enum. The commits also include the addition of new classes to handle different types of geometries, improvements in error handling, and enhancements to the script for removing unused type ignore comments. Other updates include changes to the KML schema, additions of repr and eq methods, and the implementation of a linestring. The PR title suggests that this is a release for version 1.0.alpha.6.

GitHub PRs

• #246 - Release 1.0.alpha.6

• #160 - abstractmethod for etree_element and from_element?

• #194 - Use Python Enums for kmlEnum

Click here to login to Jira
Click here to login to Confluence
Click here to login to Slack
Click here to login to Notion
Click here to login to Linear
Click here to login to Asana
fastkml is an open repo and Watermelon will serve it for free.
🍉🫶

[code-review-doctor]

Some food for thought. View full project report here.

[code-review-doctor]

Suggested change

	f")"
	")"

f-string is unnecessary here. This can just be a string. More.

[ghost]

👇 Click on the image for a new way to code review

Legend

[what-the-diff]

PR Summary

General Code Improvements

• Updated the version of the actions/checkout action from v3 to v4 in both codeql.yml and run-all-tests.yml.
• Added additional directories .pytest_cache/ and .ruff_cache/ to .gitignore.
• Updated hook versions in .pre-commit-config.yaml.
• Included additional directory recursive-include schema *.xsd to MANIFEST.in.

Documentation Updates

• A new section explaining how to run tests with coverage was added to the contributor's guide (contributing.rst).

Core Code Changes

• Removed an unnecessary import in fastkml/__init__.py.
• Several file updates, namely fastkml/atom.py, fastkml/base.py, fastkml/config.py, and fastkml/data.py, to improve the etree_element method by accepting additional parameters, improving program flexibility.
• The NAME_SPACES dictionary was added, as well as DEFAULT_NAME_SPACES being updated in fastkml/config.py.
• New enum classes Verbosity and AltitudeMode were added for better coding standards.

Significant Module Updates

• A whole suite of changes were made in fastkml/gx.py adding new functionality such as the Angle class, TrackItem class, several conversion functions, and updates to the existing Track class.
• We precise and totalize (sum) a few more lists of enums in fastkml/kml.py, fastkml/styles.py, fastkml/times.py, fastkml/types.py, fastkml/views.py.

Package and Dependency Management

• Package version in setup.py was updated from 1.0.alpha.4 to 1.0.alpha.5.
• Python version 3.12 support added in setup.py.
• pygeoif version requirement was updated and typing_extensions was added in requirements.txt.
• An option named enable_error_code with value ["ignore-without-code"] was added in pyproject.toml.

Testing

• New test methods were added in base_test.py to increase code robustness.
• Newly-added data_test.py under the tests directory.
• Created a new directory geometries under tests, containing various geometry testing files: linearring_test.py, linestring_test.py, point_test.py, polygon_test.py and geometry_test.py.
• times_test.py was updated, mostly in type hinting and datetime value modification.

Other Improvements

• The class definitions in tests/geometry_test.py (renamed to fastkml/exceptions.py) have been modified to inherit from Exception for better error handling.
• A minor conditional statement was improved in fastkml/helpers.py.

All these updates aim to enhance code quality, flexibility, code robustness, error handling, and to add new functionalities, hence improving the overall user experience.

[codecov]

Codecov Report

Attention: 41 lines in your changes are missing coverage. Please review.

Comparison is base (20f5a6e) 92.97% compared to head (b773b94) 93.18%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #246      +/-   ##
==========================================
+ Coverage   92.97%   93.18%   +0.21%     
==========================================
  Files          26       33       +7     
  Lines        4414     4787     +373     
==========================================
+ Hits         4104     4461     +357     
- Misses        310      326      +16     

Files	Coverage Δ
fastkml/__init__.py	100.00% <ø> (ø)
fastkml/atom.py	100.00% <100.00%> (ø)
fastkml/config.py	100.00% <100.00%> (ø)
fastkml/enums.py	100.00% <100.00%> (ø)
fastkml/exceptions.py	100.00% <100.00%> (ø)
fastkml/helpers.py	95.65% <100.00%> (ø)
fastkml/mixins.py	91.83% <ø> (ø)
fastkml/times.py	98.03% <100.00%> (+0.01%)	⬆️
fastkml/types.py	100.00% <100.00%> (ø)
fastkml/views.py	89.26% <100.00%> (+0.10%)	⬆️
... and 19 more

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.