-
Notifications
You must be signed in to change notification settings - Fork 4k
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
Conversation
Signed-off-by: harupy <hkawamura0130@gmail.com>
black
to use --force-exclude
optionblack
to use --force-exclude
option for simplifying pre-commit hook
black
to use --force-exclude
option for simplifying pre-commit hookblack
to use --force-exclude
option for simplifying pre-commit hook
hooks/pre-commit
Outdated
# 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..." |
There was a problem hiding this comment.
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'
.
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 |
There was a problem hiding this comment.
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>
/( | ||
# default exclude |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
.
There was a problem hiding this 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
What changes are proposed in this pull request?
Upgrade
black
to use--force-exclude
option for simplifying pre-commit hook:How is this patch tested?
NA
Does this PR change the documentation?
ci/circleci: build_doc
check. If it's successful, proceed to thenext step, otherwise fix it.
Details
on the right to open the job page of CircleCI.Artifacts
tab.docs/build/html/index.html
.Release Notes
Is this a user-facing change?
(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 loggingarea/build
: Build and test infrastructure for MLflowarea/docs
: MLflow documentation pagesarea/examples
: Example codearea/model-registry
: Model Registry service, APIs, and the fluent client calls for Model Registryarea/models
: MLmodel format, model serialization/deserialization, flavorsarea/projects
: MLproject format, project running backendsarea/scoring
: MLflow Model server, model deployment tools, Spark UDFsarea/server-infra
: MLflow Tracking server backendarea/tracking
: Tracking Service, tracking client APIs, autologgingInterface
area/uiux
: Front-end, user experience, plotting, JavaScript, JavaScript dev serverarea/docker
: Docker use across MLflow's components, such as MLflow Projects and MLflow Modelsarea/sqlalchemy
: Use of SQLAlchemy in the Tracking Service or Model Registryarea/windows
: Windows supportLanguage
language/r
: R APIs and clientslanguage/java
: Java APIs and clientslanguage/new
: Proposals for new client languagesIntegrations
integrations/azure
: Azure and Azure ML integrationsintegrations/sagemaker
: SageMaker integrationsintegrations/databricks
: Databricks integrationsHow should the PR be classified in the release notes? Choose one:
rn/breaking-change
- The PR will be mentioned in the "Breaking Changes" sectionrn/none
- No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" sectionrn/feature
- A new user-facing feature worth mentioning in the release notesrn/bug-fix
- A user-facing bug fix worth mentioning in the release notesrn/documentation
- A user-facing documentation change worth mentioning in the release notes