I have a project that have been forked and it is being formatted using Black code formatter(22.3.0) which is same version as the one defined in the original project (JinaAI). However the formatting is different and it throws off diffs.
Any suggestions are greatly appreciated to any/all issues.
My pyproject.toml
settings :
[tool.black]
line-length = 88
target-version = ['py38']
include = '\.pyi?$'
preview = false
skip-string-normalization = true
Only setting that is being applied on their project is S
flag which is skip-string-normalization = true
example 'black -S', there are no other configs that I found.
From .pre-commit-config.yaml
- repo: https://github.com/ambv/black
rev: 22.3.0
hooks:
- id: black
types: [python]
exclude: ^(jina/proto/pb/jina_pb2.py|jina/proto/pb/jina_pb2_grpc.py|jina/proto/pb2/jina_pb2.py|jina/proto/pb2/jina_pb2_grpc.py|docs/|jina/resources/)
args:
- -S
I left formatting as much as I can here so it does not change the output.
Issue # 1
Indentation is 8 spaces instead of 4.
mine:
if (
item == 'load_config' and inspect.ismethod(obj) and obj.__self__ is Flow
): # check if obj load config call from an instance and not the Class
warnings.warn(
"Calling `load_config` from a Flow instance will override all of the instance's initial parameters. We recommend to use `Flow.load_config(...)` instead"
)
theirs:
if (
item == 'load_config' and inspect.ismethod(obj) and obj.__self__ is Flow
): # check if obj load config call from an instance and not the Class
warnings.warn(
"Calling `load_config` from a Flow instance will override all of the instance's initial parameters. We recommend to use `Flow.load_config(...)` instead"
)
Issue # 2
Indentation is 8 spaces instead of 4 on methods
mine:
def to_kubernetes_yaml(
self,
output_base_path: str,
k8s_namespace: Optional[str] = None,
include_gateway: bool = True,
):
theirs:
def to_kubernetes_yaml(
self,
output_base_path: str,
k8s_namespace: Optional[str] = None,
include_gateway: bool = True,
):
Issue # 3
Not all parameters are broken down into separate lines. Example here is *
Mine has )
on separate line theirs does not.
mine:
def __init__(
self,
*,
env: Optional[dict] = None,
inspect: Optional[str] = 'COLLECT',
log_config: Optional[str] = None,
name: Optional[str] = None,
quiet: Optional[bool] = False,
quiet_error: Optional[bool] = False,
reload: Optional[bool] = False,
uses: Optional[str] = None,
workspace: Optional[str] = None,
**kwargs,
):
theirs:
def __init__(
self,*,
env: Optional[dict] = None,
inspect: Optional[str] = 'COLLECT',
log_config: Optional[str] = None,
name: Optional[str] = None,
quiet: Optional[bool] = False,
quiet_error: Optional[bool] = False,
reload: Optional[bool] = False,
uses: Optional[str] = None,
workspace: Optional[str] = None,
**kwargs):
Issue # 4
Text alignment is not same.
mine:
set_deployment_parser(
sp.add_parser(
'deployment',
description='Start a Deployment. '
'You should rarely use this directly unless you '
'are doing low-level orchestration',
formatter_class=_chf,
**(dict(help='Start a Deployment')) if _SHOW_ALL_ARGS else {},
)
)
theirs:
set_deployment_parser(
sp.add_parser(
'deployment',
description='Start a Deployment. '
'You should rarely use this directly unless you '
'are doing low-level orchestration',
formatter_class=_chf,
**(dict(help='Start a Deployment')) if _SHOW_ALL_ARGS else {},
)
)
source https://stackoverflow.com/questions/74837142/python-black-formatting-method
Comments
Post a Comment