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

Upgrade black to use --force-exclude option for simplifying pre-commit hook #5051

Merged
merged 15 commits into from
Nov 19, 2021

Conversation

harupy
Copy link
Member

@harupy harupy commented Nov 11, 2021

Signed-off-by: harupy hkawamura0130@gmail.com

What changes are proposed in this pull request?

Upgrade black to use --force-exclude option for simplifying pre-commit hook:

# Now:
# `grep -v '^mlflow/protos'` is because `--exclude` option specified in `pyproject.toml` is ignored
# when files are passed on the command line.
black --check $(echo $git_diff | grep -v '^mlflow/protos')

# With `--force-exclude`:
# We no longer need `grep -v '^mlflow/protos'`
black --check $git_diff

How is this patch tested?

NA

Does this PR change the documentation?

  • No. You can skip the rest of this section.
  • Yes. Make sure the changed pages / sections render correctly by following the steps below.
  1. Check the status of the ci/circleci: build_doc check. If it's successful, proceed to the
    next step, otherwise fix it.
  2. Click Details on the right to open the job page of CircleCI.
  3. Click the Artifacts tab.
  4. Click docs/build/html/index.html.
  5. Find the changed pages / sections and make sure they render correctly.

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/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • 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

Signed-off-by: harupy <hkawamura0130@gmail.com>
@github-actions github-actions bot added the rn/none List under Small Changes in Changelogs. label Nov 11, 2021
Signed-off-by: harupy <hkawamura0130@gmail.com>
@harupy harupy changed the title [WIP] Upgrade black to use --force-exclude option [WIP] Upgrade black to use --force-exclude option for simplifying pre-commit hook Nov 11, 2021
@harupy harupy changed the title [WIP] Upgrade black to use --force-exclude option for simplifying pre-commit hook Upgrade black to use --force-exclude option for simplifying pre-commit hook Nov 11, 2021
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
hooks/pre-commit Outdated
Comment on lines 6 to 34
# We specify `--exclude` option in `pyproject.toml`,
# but it's only consulted for recursive search, not for files passed on the command line:
# https://github.com/psf/black/issues/438#issuecomment-413886281
# `--force-exclude` option can solve this issue, but black >= 20.8b0 is required:
# https://black.readthedocs.io/en/stable/change_log.html#id26
# TODO: Upgrade black to >= 20.8b0 and use `--force-exclude`
black --check $(echo $diff | grep -v '^mlflow/protos')
echo "Running black..."
black --check $diff
echo "Running pylint..."
Copy link
Member Author

Choose a reason for hiding this comment

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

We no longer need to use grep -v '^mlflow/protos'.

Signed-off-by: harupy <hkawamura0130@gmail.com>
Comment on lines -74 to +79
Lists files and directories under artifacts directory for the current run_id.
(self.path contains the base path - hdfs:/some/path/run_id/artifacts)
Lists files and directories under artifacts directory for the current run_id.
(self.path contains the base path - hdfs:/some/path/run_id/artifacts)

:param path: Relative source path. Possible subdirectory existing under
hdfs:/some/path/run_id/artifacts
:return: List of FileInfos under given path
:param path: Relative source path. Possible subdirectory existing under
hdfs:/some/path/run_id/artifacts
:return: List of FileInfos under given path
Copy link
Member Author

@harupy harupy Nov 12, 2021

Choose a reason for hiding this comment

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

Black 21.10b0 automatically aligns docstrings.

Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
/(
# default exclude
Copy link
Member

Choose a reason for hiding this comment

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

this new version of black has a config that ignores all of these automatically?

Copy link
Member Author

@harupy harupy Nov 18, 2021

Choose a reason for hiding this comment

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

If we specify exclude, it overwrites the default value of exclude.
If we don't, black should automatically use the default value of exclude.

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.

If for nothing else, the docstring formatter in this new version is great!

Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
@harupy harupy merged commit 0fa849a into mlflow:master Nov 19, 2021
@harupy harupy mentioned this pull request Nov 19, 2021
29 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rn/none List under Small Changes in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants