Version 1.5.1

[cleder]

User description

---

PR Type

enhancement, tests, documentation

---

Description

• Enhanced Sphinx documentation with GitHub integration and added sphinx.ext.viewcode.
• Exposed force_2d and force_3d factories in the top-level module.
• Improved WKT parsing for nested GeometryCollections and updated WKT output for MultiPoints.
• Made hypothesis strategy for GeometryCollections recursive to support nested collections.
• Updated CI workflows to include Python 3.14 and refactored package build and publish steps.
• Updated pre-commit hooks and added ruff-format.
• Updated README with Conda badge and new download link.

---

Changes walkthrough 📝

	Relevant files
Documentation	2 files conf.py Enhance Sphinx documentation with GitHub integration          docs/conf.py Added sphinx.ext.viewcode to Sphinx extensions. Configured GitHub integration in Sphinx HTML context. +9/-0      README.rst Update badges and links in README                                                README.rst Added Conda badge for version display. Updated download link to pepy.tech. +5/-7
Enhancement	3 files __init__.py Expose additional factories in top-level module                    pygeoif/init.py Exposed force_2d and force_3d factories in the top-level module. +5/-0      factories.py Enhance WKT parsing and update copyright                                  pygeoif/factories.py Added split_wkt_components function for WKT parsing. Improved WKT parsing for nested GeometryCollections. Updated copyright year to 2024. +41/-14  geometry.py Improve WKT output and refactor methods                                    pygeoif/geometry.py Improved WKT output for MultiPoints. Refactored _prepare_hull method for clarity. +15/-15
Configuration changes	3 files about.py Bump version to 1.5.1                                                                        pygeoif/about.py Updated version number to 1.5.1. +1/-1      run-all-tests.yml Update CI workflows and add Python 3.14                                    .github/workflows/run-all-tests.yml Added Python 3.14 to test matrix. Updated Codecov and other GitHub Actions versions. Refactored workflow for package build and publish. +64/-33  .pre-commit-config.yaml Update pre-commit hooks and add ruff-format                            .pre-commit-config.yaml Updated pre-commit hooks versions. Added ruff-format hook. +12/-11
Formatting	3 files feature.py Code formatting improvements                                                          pygeoif/feature.py Minor formatting changes for consistency. +2/-3      functions.py Code formatting improvements                                                          pygeoif/functions.py Minor formatting changes for consistency. +1/-0      types.py Code formatting improvements                                                          pygeoif/types.py Minor formatting changes for consistency. +2/-1
Tests	4 files strategies.py Enhance hypothesis strategy for nested collections              pygeoif/hypothesis/strategies.py Made GeometryCollections strategy recursive for nested collections. +23/-6    test_factories.py Update tests for WKT output                                                            tests/test_factories.py Updated test for WKT output of MultiPoints. +1/-1      test_geometrycollection.py Update tests for nested GeometryCollections                            tests/test_geometrycollection.py Updated tests for WKT parsing of nested GeometryCollections. +3/-6      test_multipoint.py Update tests for WKT output                                                            tests/test_multipoint.py Updated test for WKT output of MultiPoints. +1/-1

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[semanticdiff-com]

Review changes with  

Changed Files

File	Status
pygeoif/feature.py	100% smaller
pygeoif/geometry.py	39% smaller
pygeoif/factories.py	11% smaller
tests/test_geometrycollection.py	1% smaller
.github/workflows/run-all-tests.yml	Unsupported file format
.pre-commit-config.yaml	Unsupported file format
README.rst	Unsupported file format
docs/HISTORY.rst	Unsupported file format
docs/conf.py	0% smaller
pygeoif/__init__.py	0% smaller
pygeoif/about.py	0% smaller
pygeoif/functions.py	0% smaller
pygeoif/hypothesis/strategies.py	0% smaller
pygeoif/types.py	0% smaller
pyproject.toml	Unsupported file format
tests/test_factories.py	0% smaller
tests/test_multipoint.py	0% smaller
tox.ini	Unsupported file format

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR updates the package to version 1.5.1, focusing on code quality improvements, dependency updates, and CI/CD pipeline enhancements. The changes include updates to Python version support, linting configurations, and improvements to WKT (Well-Known Text) handling for geometric collections.

Class diagram for updated WKT handling

classDiagram
    class Factories {
        +split_wkt_components(wkt: str) List~str~
        +_multigeometry_from_wkt_coordinates(coordinates: str) GeometryCollection
    }
    class GeometryCollection {
        +_prepare_hull() Iterable~Point2D~
    }
    class MultiLineString {
        +_prepare_hull() Iterable~Point2D~
    }
    class MultiPolygon {
        +_prepare_hull() Iterable~Point2D~
    }
    Factories --> GeometryCollection
    Factories --> MultiLineString
    Factories --> MultiPolygon
    note for Factories "New method split_wkt_components added"
    note for GeometryCollection "Updated _prepare_hull method"
    note for MultiLineString "Updated _prepare_hull method"
    note for MultiPolygon "Updated _prepare_hull method"

Loading

File-Level Changes

Change	Details	Files
Updated Python version support and CI workflow	Added support for Python 3.14 Updated Python version matrix in CI workflow Updated codecov-action from v4 to v5 Replaced black with ruff format for code formatting	.github/workflows/run-all-tests.yml pyproject.toml
Enhanced WKT handling and geometry processing	Added new split_wkt_components function for better WKT parsing Improved MultiPoint WKT formatting Fixed nested GeometryCollection WKT handling Optimized geometry hull preparation methods	pygeoif/factories.py pygeoif/geometry.py tests/test_geometrycollection.py tests/test_multipoint.py
Updated development tooling and configurations	Updated pre-commit hooks to latest versions Simplified ruff linting configuration Added viewcode extension to Sphinx documentation Updated copyright year to 2024	.pre-commit-config.yaml docs/conf.py pygeoif/factories.py pyproject.toml
Improved package publishing workflow	Split publish job into test-publish and publish steps Added build-and-check-package job Implemented package verification before publishing Added pyroma checks for package quality	.github/workflows/run-all-tests.yml

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[pep8speaks]

Hello @cleder! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file pygeoif/feature.py:

Line 233:90: E501 line too long (112 > 89 characters)

Comment last updated at 2024-12-05 20:29:10 UTC

[what-the-diff]

PR Summary

• Upgraded Python version and linting tool in CI configuration
  Our continuous integration (CI) settings have been updated to use a newer version of Python (3.14-dev up from 3.13-dev). Also, a change was made to the linting command used commonly for checking the quality of the codebase.

• Enhanced code coverage analysis and package building process
  The process through which we assess how much of our code is covered by our tests has been upgraded. Alongside, we have added a new job to automate the process of building and inspecting our program package.

• Improved package validation during CI process
  New processes have been incorporated during the CI workflow to ensure that the software package we're building is valid and satisfactory using tools such as pyroma and vercheck.

• Streamlined package publishing job
  The process of uploading our software to the Test PyPI and PyPI platforms (where others can download and use it) has been simplified.

• Optimized coding practices with updated pre-commit tools
  The tools we use before every commit for automatically checking code quality and ensuring standards ('black', 'ruff' etc.) have been updated.

• Added Conda badge and updated download link in README
  An enhancement to the README document includes a badge for Conda package and an updated download link.

• Increased accessibility of geometry factories and WKT parsing
  There is improved accessibility to particular features related to geometrical object creation and parsing of Well-Known Text (WKT) strings into components.

• **Modified WKT representation and enhanced handling of nested GeometryCollections **
  Changes in the testing phase include updated representation for MultiPoint and GeometryCollection objects using WKT notation. Moreover, our strategy to handle nested GeometryCollections in geometrical operations has been enhanced.

• Overall code enhancements
  Some minor changes across the codebase have been done to make the code easier to read and maintain.

• Version increment
  The version number of our package is raised to 1.5.1 from 1.5.0 as a part of this update.

[github-actions]

Preparing review...

[github-actions]

Preparing review...

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪

🧪 PR contains tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Code Complexity The new split_wkt_components function has nested loops and multiple conditions that could be simplified or broken down into smaller functions for better maintainability Possible Bug The changes to MultiPoint WKT output format could potentially break compatibility with some WKT parsers that expect a different format CI Pipeline The new build and publish workflow changes introduce more complexity and dependencies that should be carefully tested to ensure reliable package deployment

[sourcery-ai]

Hey @cleder - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 2 issues found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

suggestion (performance): Consider using 'yield from' instead of chain.from_iterable for simpler and more efficient iteration

Using 'yield from' provides a more straightforward and memory-efficient way to flatten nested iterables compared to chain.from_iterable.

    def _prepare_hull(self) -> Iterable[Point2D]:
        for geom in self.geoms:
            yield from geom._prepare_hull()  # noqa: SLF001

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Possible issue	Validate balanced parentheses in input strings to prevent incorrect parsing of malformed data The split_wkt_components() function should validate that parentheses are properly balanced before processing, to avoid incorrect parsing of malformed WKT strings. pygeoif/factories.py [280-283] def split_wkt_components(wkt: str) -> List[str]: + if wkt.count("(") != wkt.count(")"): + raise ValueError("Unbalanced parentheses in WKT string") components = [] start = 0 open_count = 0 Apply this suggestion Suggestion importance[1-10]: 8 Why: Early validation of WKT string format would prevent incorrect parsing and potential errors later in the process, improving data integrity and error handling.	8
	Handle empty input strings properly in string splitting function to avoid returning invalid components The split_wkt_components() function should handle empty input strings by returning an empty list instead of a list containing an empty string. pygeoif/factories.py [308-310] -# Add the final component -components.append(wkt[start:].strip()) +# Add the final component if non-empty +final_component = wkt[start:].strip() +if final_component: + components.append(final_component) return components Apply this suggestion Suggestion importance[1-10]: 7 Why: The suggestion improves robustness by preventing empty components from being added to the result list, which could cause issues in downstream processing.	7

💡 Need additional feedback ? start a PR chat

[github-actions]

Failed to generate code suggestions for PR

[ellipsis-dev]

👍 Looks good to me! Reviewed everything up to 2c889df in 1 minute and 53 seconds

More details

• Looked at 822 lines of code in 18 files
• Skipped 0 files when reviewing.
• Skipped posting 8 drafted comments based on config settings.

1. .github/workflows/run-all-tests.yml:71

• Draft comment:
  Ensure that the update to codecov-action@v5 is compatible with your current configuration, as major version updates may introduce breaking changes.
• Reason this comment was not posted:
  Comment did not seem useful.

2. .github/workflows/run-all-tests.yml:100

• Draft comment:
  Verify that the change to ruff format --check and ruff check --no-fix aligns with the intended linting behavior, as this modifies how ruff is executed.
• Reason this comment was not posted:
  Comment did not seem useful.

3. .github/workflows/run-all-tests.yml:168

• Draft comment:
  Ensure that pypa/gh-action-pypi-publish@release/v1 is compatible with your current workflow and secrets configuration, as this action handles package publishing.
• Reason this comment was not posted:
  Comment did not seem useful.

4. .github/workflows/run-all-tests.yml:191

• Draft comment:
  Ensure that pypa/gh-action-pypi-publish@release/v1 is compatible with your current workflow and secrets configuration, as this action handles package publishing.
• Reason this comment was not posted:
  Marked as duplicate.

5. .pre-commit-config.yaml:7

• Draft comment:
  Ensure that the update to pre-commit-hooks version v5.0.0 is compatible with your current configuration, as major version updates may introduce breaking changes.
• Reason this comment was not posted:
  Marked as duplicate.

6. .pre-commit-config.yaml:44

• Draft comment:
  Ensure that the update to ruff-pre-commit version v0.8.1 is compatible with your current configuration, as version updates may introduce changes.
• Reason this comment was not posted:
  Comment did not seem useful.

7. .pre-commit-config.yaml:49

• Draft comment:
  Ensure that the update to flake8 version 7.1.1 is compatible with your current configuration, as version updates may introduce changes.
• Reason this comment was not posted:
  Marked as duplicate.

8. .pre-commit-config.yaml:72

• Draft comment:
  Ensure that the update to mypy version v1.13.0 is compatible with your current configuration, as version updates may introduce changes.
• Reason this comment was not posted:
  Marked as duplicate.

Workflow ID: wflow_GXHaInce321wl0Fb

---

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

[llamapreview]

Auto Pull Request Review from LlamaPReview

Large PR Notification

Dear contributor,

Thank you for your substantial contribution to this project. LlamaPReview has detected that this Pull Request contains a large volume of changes, which exceeds our current processing capacity.

Details:

• PR and related contents total size: Approximately 57,871 characters
• Current limit: 50,000 characters

Next steps:

1. Consider breaking this PR into smaller, more focused changes if possible.
2. For manual review, please reach out to your team members or maintainers.

We appreciate your understanding and commitment to improving this project. Your contributions are valuable, and we want to ensure they receive the attention they deserve.

LlamaPReview is continuously evolving to better serve the community. Share your thoughts on handling large PRs in our GitHub Discussions - your feedback helps us improve and expand our capabilities.

If you have any questions or need assistance, our community and support team are here to help.

Best regards,
LlamaPReview Team

[codiumai-pr-agent-free]

CI Failure Feedback 🧐

(Checks updated until commit 1fbadeb)

Action: static-tests (3.11)

Failed stage: Typecheck [❌]

Failure summary: The action failed because a static type checking tool (likely mypy) detected an unreachable statement in the file pygeoif/factories.py at line 95. This indicates a potential logical error in the code where a part of the code cannot be executed under any circumstances.

Relevant error logs: 1: ##[group]Operating System 2: Ubuntu ... 369: env: 370: pythonLocation: /opt/hostedtoolcache/Python/3.11.10/x64 371: PKG_CONFIG_PATH: /opt/hostedtoolcache/Python/3.11.10/x64/lib/pkgconfig 372: Python_ROOT_DIR: /opt/hostedtoolcache/Python/3.11.10/x64 373: Python2_ROOT_DIR: /opt/hostedtoolcache/Python/3.11.10/x64 374: Python3_ROOT_DIR: /opt/hostedtoolcache/Python/3.11.10/x64 375: LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/3.11.10/x64/lib 376: ##[endgroup] 377: pygeoif/factories.py:95: error: Statement is unreachable [unreachable] 378: Found 1 error in 1 file (checked 35 source files) 379: ##[error]Process completed with exit code 1.

---

✨ CI feedback usage guide:

---

The CI feedback tool (/checks) automatically triggers when a PR has a failed check.
The tool analyzes the failed checks and provides several feedbacks:

• Failed stage
• Failed test name
• Failure summary
• Relevant error logs

In addition to being automatically triggered, the tool can also be invoked manually by commenting on a PR:

/checks "https://github.com/{repo_name}/actions/runs/{run_number}/job/{job_number}"

where {repo_name} is the name of the repository, {run_number} is the run number of the failed check, and {job_number} is the job number of the failed check.

Configuration options

• enable_auto_checks_feedback - if set to true, the tool will automatically provide feedback when a check is failed. Default is true.
• excluded_checks_list - a list of checks to exclude from the feedback, for example: ["check1", "check2"]. Default is an empty list.
• enable_help_text - if set to true, the tool will provide a help message with the feedback. Default is true.
• persistent_comment - if set to true, the tool will overwrite a previous checks comment with the new feedback. Default is true.
• final_update_message - if persistent_comment is true and updating a previous checks message, the tool will also create a new message: "Persistent checks updated to latest commit". Default is true.

See more information about the checks tool in the docs.

[github-actions]

Preparing review...

[github-actions]

Preparing review...