You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by po...@apache.org on 2021/01/02 10:52:40 UTC
[airflow] branch master updated: Fix pylint issues - broken master
(#13427)
This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/master by this push:
new 1016584 Fix pylint issues - broken master (#13427)
1016584 is described below
commit 10165849b28c769f8b4aab4958ee6a3d1e47c3ce
Author: Kamil BreguĊa <mi...@users.noreply.github.com>
AuthorDate: Sat Jan 2 11:52:25 2021 +0100
Fix pylint issues - broken master (#13427)
---
docs/build_docs.py | 8 +++-----
docs/exts/docs_build/docs_builder.py | 19 +++++++++----------
2 files changed, 12 insertions(+), 15 deletions(-)
diff --git a/docs/build_docs.py b/docs/build_docs.py
index 120a90e..f0486eb 100755
--- a/docs/build_docs.py
+++ b/docs/build_docs.py
@@ -137,19 +137,17 @@ def build_docs_for_packages(
all_spelling_errors: Dict[str, List[SpellingError]] = defaultdict(list)
for package_no, package_name in enumerate(current_packages, start=1):
print("#" * 20, f"[{package_no}/{len(current_packages)}] {package_name}", "#" * 20)
- builder = AirflowDocsBuilder(
- package_name=package_name, for_production=for_production, verbose=verbose
- )
+ builder = AirflowDocsBuilder(package_name=package_name, for_production=for_production)
builder.clean_files()
if not docs_only:
with with_group(f"Check spelling: {package_name}"):
- spelling_errors = builder.check_spelling()
+ spelling_errors = builder.check_spelling(verbose=verbose)
if spelling_errors:
all_spelling_errors[package_name].extend(spelling_errors)
if not spellcheck_only:
with with_group(f"Building docs: {package_name}"):
- docs_errors = builder.build_sphinx_docs()
+ docs_errors = builder.build_sphinx_docs(verbose=verbose)
if docs_errors:
all_build_errors[package_name].extend(docs_errors)
diff --git a/docs/exts/docs_build/docs_builder.py b/docs/exts/docs_build/docs_builder.py
index 55db419..6874f78 100644
--- a/docs/exts/docs_build/docs_builder.py
+++ b/docs/exts/docs_build/docs_builder.py
@@ -43,10 +43,9 @@ PROCESS_TIMEOUT = 4 * 60
class AirflowDocsBuilder:
"""Documentation builder for Airflow."""
- def __init__(self, package_name: str, for_production: bool, verbose: bool):
+ def __init__(self, package_name: str, for_production: bool):
self.package_name = package_name
self.for_production = for_production
- self.verbose = verbose
@property
def _doctree_dir(self) -> str:
@@ -100,7 +99,7 @@ class AirflowDocsBuilder:
os.makedirs(api_dir, exist_ok=True)
os.makedirs(self._build_dir, exist_ok=True)
- def check_spelling(self):
+ def check_spelling(self, verbose):
"""Checks spelling."""
spelling_errors = []
with TemporaryDirectory() as tmp_dir, NamedTemporaryFile() as output:
@@ -119,7 +118,7 @@ class AirflowDocsBuilder:
tmp_dir,
]
print("Executing cmd: ", " ".join([shlex.quote(c) for c in build_cmd]))
- if not self.verbose:
+ if not verbose:
print("The output is hidden until an error occurs.")
env = os.environ.copy()
env['AIRFLOW_PACKAGE_NAME'] = self.package_name
@@ -129,8 +128,8 @@ class AirflowDocsBuilder:
build_cmd,
cwd=self._src_dir,
env=env,
- stdout=output if not self.verbose else None,
- stderr=output if not self.verbose else None,
+ stdout=output if not verbose else None,
+ stderr=output if not verbose else None,
timeout=PROCESS_TIMEOUT,
)
if completed_proc.returncode != 0:
@@ -157,7 +156,7 @@ class AirflowDocsBuilder:
spelling_errors.extend(parse_spelling_warnings(warning_text, self._src_dir))
return spelling_errors
- def build_sphinx_docs(self) -> List[DocBuildError]:
+ def build_sphinx_docs(self, verbose) -> List[DocBuildError]:
"""Build Sphinx documentation"""
build_errors = []
with NamedTemporaryFile() as tmp_file, NamedTemporaryFile() as output:
@@ -177,7 +176,7 @@ class AirflowDocsBuilder:
self._build_dir, # path to output directory
]
print("Executing cmd: ", " ".join([shlex.quote(c) for c in build_cmd]))
- if not self.verbose:
+ if not verbose:
print("The output is hidden until an error occurs.")
env = os.environ.copy()
@@ -189,8 +188,8 @@ class AirflowDocsBuilder:
build_cmd,
cwd=self._src_dir,
env=env,
- stdout=output if not self.verbose else None,
- stderr=output if not self.verbose else None,
+ stdout=output if not verbose else None,
+ stderr=output if not verbose else None,
timeout=PROCESS_TIMEOUT,
)
if completed_proc.returncode != 0: