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.

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

Sort import statements (excluding mlflow for now) #9409

Merged
merged 4 commits into from
Aug 23, 2023

Conversation

harupy
Copy link
Member

@harupy harupy commented Aug 22, 2023

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Sort import statements (excluding mlflow for now) to ban unnecessary changes on import statements.

I've made a comment like "Hey, can you revert unnecessary changes on import statements" countless times, which is a pain. Once this PR is merged, I will no longer have to.

How is this patch tested?

  • Existing unit/integration tests
  • New unit/integration tests
  • Manual tests (describe details, including test results, below)

Does this PR require documentation update?

  • No. You can skip the rest of this section.
  • Yes. I've updated:
    • Examples
    • API references
    • Instructions

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release notes for MLflow users.

(Details in 1-2 sentences. You can just refer to another PR with a description if this PR is part of a larger change.)

What component(s), interfaces, languages, and integrations does this PR affect?

Components

  • area/artifacts: Artifact stores and artifact logging
  • area/build: Build and test infrastructure for MLflow
  • area/docs: MLflow documentation pages
  • area/examples: Example code
  • area/gateway: AI Gateway service, Gateway client APIs, third-party Gateway integrations
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/recipes: Recipes, Recipe APIs, Recipe configs, Recipe Templates
  • area/projects: MLproject format, project running backends
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/server-infra: MLflow Tracking server backend
  • area/tracking: Tracking Service, tracking client APIs, autologging

Interface

  • area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
  • area/docker: Docker use across MLflow's components, such as MLflow Projects and MLflow Models
  • area/sqlalchemy: Use of SQLAlchemy in the Tracking Service or Model Registry
  • area/windows: Windows support

Language

  • language/r: R APIs and clients
  • language/java: Java APIs and clients
  • language/new: Proposals for new client languages

Integrations

  • integrations/azure: Azure and Azure ML integrations
  • integrations/sagemaker: SageMaker integrations
  • integrations/databricks: Databricks integrations

How should the PR be classified in the release notes? Choose one:

  • rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
  • rn/feature - A new user-facing feature worth mentioning in the release notes
  • rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
  • rn/documentation - A user-facing documentation change worth mentioning in the release notes

@harupy harupy added the only-latest If applied, only test the latest version of each group in cross-version tests. label Aug 22, 2023
@github-actions github-actions bot added the rn/none List under Small Changes in Changelogs. label Aug 22, 2023
@mlflow-automation
Copy link
Collaborator

mlflow-automation commented Aug 22, 2023

Documentation preview for c969075 will be available here when this CircleCI job completes successfully.

More info

Comment on lines +76 to +80
"mlflow/*" = [
"PT018",
# TODO: Sort imports in files under `mlflow` as well
"I",
]
Copy link
Member Author

Choose a reason for hiding this comment

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

Disabled for now because changing the import order may lead to circular imports.

Copy link
Member

@BenWilson2 BenWilson2 left a comment

Choose a reason for hiding this comment

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

thanks for enabling this lint check standardization.

@harupy
Copy link
Member Author

harupy commented Aug 22, 2023

@chenmoneygithub Thoughts on this?

@@ -18,6 +18,7 @@ select = [
"E",
"F",
"C4",
"I",
Copy link
Member Author

Choose a reason for hiding this comment

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

If this is too strict and we want to disable import sorting, we can remove this line.

Signed-off-by: harupy <[email protected]>
Signed-off-by: harupy <[email protected]>
Signed-off-by: harupy <[email protected]>
@harupy harupy merged commit 5ed36a0 into mlflow:master Aug 23, 2023
57 of 58 checks passed
@harupy harupy deleted the sort-imports branch August 23, 2023 02:30
clarkh-ncino pushed a commit to ncino/mlflow that referenced this pull request Aug 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
only-latest If applied, only test the latest version of each group in cross-version tests. rn/none List under Small Changes in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants