Skip to content

Make fiona an optional dependency#57

Open
lispandfound wants to merge 1 commit intomainfrom
optional_fiona
Open

Make fiona an optional dependency#57
lispandfound wants to merge 1 commit intomainfrom
optional_fiona

Conversation

@lispandfound
Copy link
Copy Markdown
Contributor

Per title. Fiona is an annoying dependency because it doesn't have wheels built for the most recent version of pythons, and that requires GDAL to be installed. On clusters with module python dragged in as a dependency (e.g. RCH), this results in weird bugs that are hard to track down. Considering it is only used for the community fault model I believe making it an optional dependency is a better balance.

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refactors the project's dependency management by making the 'fiona' library optional. This change directly addresses recurring installation challenges caused by 'fiona's' reliance on GDAL, especially in complex environments like shared clusters. By allowing 'fiona' to be installed conditionally, the project enhances its usability and reduces setup friction for users who do not require its specific functionalities, such as those related to the community fault model.

Highlights

  • Dependency Management: The 'fiona' library has been transitioned from a mandatory core dependency to an optional dependency. This change aims to alleviate installation issues, particularly those related to its underlying GDAL dependency, which can be problematic in certain environments.
  • Configuration Update: A new optional dependency group named 'fiona' was introduced in 'pyproject.toml' to allow users to install 'fiona' only when needed, providing greater flexibility.
Changelog
  • pyproject.toml
    • Removed 'fiona' from the main 'dependencies' list.
    • Added a new optional dependency group 'fiona' under '[project.optional-dependencies]'.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request aims to make fiona an optional dependency. While this is a good initiative, the PR is currently incomplete. It removes fiona from the core dependencies but does not include the necessary changes in the Python code to handle cases where fiona is not installed. This will lead to ImportError crashes for users who do not install the [fiona] extra. This critical issue needs to be addressed by adding error handling for the optional import.

requires-python = ">=3.11,<3.14"
dynamic = ["version"]
dependencies = [
"fiona",
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.

critical

Removing fiona from the core dependencies without updating the code that uses it will cause the application to crash with an ImportError if fiona is not installed. Please add the necessary changes to the Python code to handle the optional import of fiona. This typically involves a try...except ImportError block where fiona is imported, and then gracefully disabling or providing an informative error for features that depend on it.

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.

1 participant