Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Enable 'Public function Missing Docstrings' PyDocStyle Check (#9463)
  • Loading branch information
kaxil committed Jun 21, 2020
1 parent 13e95d1 commit 5d61580
Show file tree
Hide file tree
Showing 58 changed files with 144 additions and 109 deletions.
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Expand Up @@ -182,7 +182,7 @@ metastore_browser/templates/.*\\.html$|.*\\.jinja2"
name: Run pydocstyle
args:
- --convention=pep257
- --add-ignore=D100,D102,D103,D104,D105,D106,D107,D200,D202,D204,D205,D207,D208,D210,D400,D401,D403
- --add-ignore=D100,D102,D104,D105,D106,D107,D200,D202,D204,D205,D207,D208,D210,D400,D401,D403
exclude: ^tests/.*\.py$|^scripts/.*\.py$|^dev|^backport_packages|^kubernetes_tests
- repo: local
hooks:
Expand Down
23 changes: 13 additions & 10 deletions airflow/configuration.py
Expand Up @@ -590,10 +590,12 @@ def _warn_deprecate(section, key, deprecated_section, deprecated_name):


def get_airflow_home():
"""Get path to Airflow Home"""
return expand_env_var(os.environ.get('AIRFLOW_HOME', '~/airflow'))


def get_airflow_config(airflow_home):
"""Get Path to airflow.cfg path"""
if 'AIRFLOW_CONFIG' not in os.environ:
return os.path.join(airflow_home, 'airflow.cfg')
return expand_env_var(os.environ['AIRFLOW_CONFIG'])
Expand Down Expand Up @@ -641,6 +643,7 @@ def parameterized_config(template):


def get_airflow_test_config(airflow_home):
"""Get path to unittests.cfg"""
if 'AIRFLOW_TEST_CONFIG' not in os.environ:
return os.path.join(airflow_home, 'unittests.cfg')
return expand_env_var(os.environ['AIRFLOW_TEST_CONFIG'])
Expand Down Expand Up @@ -714,7 +717,7 @@ def get_airflow_test_config(airflow_home):


# Historical convenience functions to access config entries
def load_test_config():
def load_test_config(): # noqa: D103
warnings.warn(
"Accessing configuration method 'load_test_config' directly from the configuration module is "
"deprecated. Please access the configuration from the 'configuration.conf' object via "
Expand All @@ -725,7 +728,7 @@ def load_test_config():
conf.load_test_config()


def get(*args, **kwargs):
def get(*args, **kwargs): # noqa: D103
warnings.warn(
"Accessing configuration method 'get' directly from the configuration module is "
"deprecated. Please access the configuration from the 'configuration.conf' object via "
Expand All @@ -736,7 +739,7 @@ def get(*args, **kwargs):
return conf.get(*args, **kwargs)


def getboolean(*args, **kwargs):
def getboolean(*args, **kwargs): # noqa: D103
warnings.warn(
"Accessing configuration method 'getboolean' directly from the configuration module is "
"deprecated. Please access the configuration from the 'configuration.conf' object via "
Expand All @@ -747,7 +750,7 @@ def getboolean(*args, **kwargs):
return conf.getboolean(*args, **kwargs)


def getfloat(*args, **kwargs):
def getfloat(*args, **kwargs): # noqa: D103
warnings.warn(
"Accessing configuration method 'getfloat' directly from the configuration module is "
"deprecated. Please access the configuration from the 'configuration.conf' object via "
Expand All @@ -758,7 +761,7 @@ def getfloat(*args, **kwargs):
return conf.getfloat(*args, **kwargs)


def getint(*args, **kwargs):
def getint(*args, **kwargs): # noqa: D103
warnings.warn(
"Accessing configuration method 'getint' directly from the configuration module is "
"deprecated. Please access the configuration from the 'configuration.conf' object via "
Expand All @@ -769,7 +772,7 @@ def getint(*args, **kwargs):
return conf.getint(*args, **kwargs)


def getsection(*args, **kwargs):
def getsection(*args, **kwargs): # noqa: D103
warnings.warn(
"Accessing configuration method 'getsection' directly from the configuration module is "
"deprecated. Please access the configuration from the 'configuration.conf' object via "
Expand All @@ -780,7 +783,7 @@ def getsection(*args, **kwargs):
return conf.getint(*args, **kwargs)


def has_option(*args, **kwargs):
def has_option(*args, **kwargs): # noqa: D103
warnings.warn(
"Accessing configuration method 'has_option' directly from the configuration module is "
"deprecated. Please access the configuration from the 'configuration.conf' object via "
Expand All @@ -791,7 +794,7 @@ def has_option(*args, **kwargs):
return conf.has_option(*args, **kwargs)


def remove_option(*args, **kwargs):
def remove_option(*args, **kwargs): # noqa: D103
warnings.warn(
"Accessing configuration method 'remove_option' directly from the configuration module is "
"deprecated. Please access the configuration from the 'configuration.conf' object via "
Expand All @@ -802,7 +805,7 @@ def remove_option(*args, **kwargs):
return conf.remove_option(*args, **kwargs)


def as_dict(*args, **kwargs):
def as_dict(*args, **kwargs): # noqa: D103
warnings.warn(
"Accessing configuration method 'as_dict' directly from the configuration module is "
"deprecated. Please access the configuration from the 'configuration.conf' object via "
Expand All @@ -813,7 +816,7 @@ def as_dict(*args, **kwargs):
return conf.as_dict(*args, **kwargs)


def set(*args, **kwargs):
def set(*args, **kwargs): # noqa: D103
warnings.warn(
"Accessing configuration method 'set' directly from the configuration module is "
"deprecated. Please access the configuration from the 'configuration.conf' object via "
Expand Down
2 changes: 1 addition & 1 deletion airflow/example_dags/libs/helper.py
Expand Up @@ -18,5 +18,5 @@


# pylint: disable=missing-docstring
def print_stuff():
def print_stuff(): # noqa: D103
print("annotated!")
2 changes: 1 addition & 1 deletion airflow/lineage/entities.py
Expand Up @@ -83,7 +83,7 @@ class Column:
# https://github.com/python/mypy/issues/6136 is resolved, use
# `attr.converters.default_if_none(default=False)`
# pylint: disable=missing-docstring
def default_if_none(arg: Optional[bool]) -> bool:
def default_if_none(arg: Optional[bool]) -> bool: # noqa: D103
return arg or False


Expand Down
2 changes: 2 additions & 0 deletions airflow/logging_config.py
Expand Up @@ -28,6 +28,7 @@


def configure_logging():
"""Configure & Validate Airflow Logging"""
logging_class_path = ''
try:
logging_class_path = conf.get('logging', 'logging_config_class')
Expand Down Expand Up @@ -72,6 +73,7 @@ def configure_logging():


def validate_logging_config(logging_config):
"""Validate the provided Logging Config"""
# Now lets validate the other logging-related settings
task_log_reader = conf.get('logging', 'task_log_reader')

Expand Down
4 changes: 2 additions & 2 deletions airflow/migrations/versions/03bc53e68815_add_sm_dag_index.py
Expand Up @@ -32,9 +32,9 @@
depends_on = None


def upgrade():
def upgrade(): # noqa: D103
op.create_index('sm_dag', 'sla_miss', ['dag_id'], unique=False)


def downgrade():
def downgrade(): # noqa: D103
op.drop_index('sm_dag', table_name='sla_miss')
4 changes: 2 additions & 2 deletions airflow/migrations/versions/05f30312d566_merge_heads.py
Expand Up @@ -30,9 +30,9 @@
depends_on = None


def upgrade():
def upgrade(): # noqa: D103
pass


def downgrade():
def downgrade(): # noqa: D103
pass
Expand Up @@ -41,19 +41,19 @@
# For Microsoft SQL Server, TIMESTAMP is a row-id type,
# having nothing to do with date-time. DateTime() will
# be sufficient.
def mssql_timestamp():
def mssql_timestamp(): # noqa: D103
return sa.DateTime()


def mysql_timestamp():
def mysql_timestamp(): # noqa: D103
return mysql.TIMESTAMP(fsp=6)


def sa_timestamp():
def sa_timestamp(): # noqa: D103
return sa.TIMESTAMP(timezone=True)


def upgrade():
def upgrade(): # noqa: D103
# See 0e2a74e0fc9f_add_time_zone_awareness
conn = op.get_bind()
if conn.dialect.name == 'mysql':
Expand Down Expand Up @@ -89,6 +89,6 @@ def upgrade():
)


def downgrade():
def downgrade(): # noqa: D103
op.drop_index(INDEX_NAME, table_name=TABLE_NAME)
op.drop_table(TABLE_NAME)
Expand Up @@ -34,7 +34,7 @@
depends_on = None


def upgrade():
def upgrade(): # noqa: D103
conn = op.get_bind()
if conn.dialect.name == "mysql":
conn.execute("SET time_zone = '+00:00'")
Expand Down Expand Up @@ -305,7 +305,7 @@ def upgrade():
)


def downgrade():
def downgrade(): # noqa: D103
conn = op.get_bind()
if conn.dialect.name == "mysql":
conn.execute("SET time_zone = '+00:00'")
Expand Down
Expand Up @@ -32,9 +32,9 @@
depends_on = None


def upgrade():
def upgrade(): # noqa: D103
op.create_index('dag_id_state', 'dag_run', ['dag_id', 'state'], unique=False)


def downgrade():
def downgrade(): # noqa: D103
op.drop_index('dag_id_state', table_name='dag_run')
4 changes: 2 additions & 2 deletions airflow/migrations/versions/13eb55f81627_for_compatibility.py
Expand Up @@ -31,9 +31,9 @@
depends_on = None


def upgrade():
def upgrade(): # noqa: D103
pass


def downgrade():
def downgrade(): # noqa: D103
pass
Expand Up @@ -41,7 +41,7 @@
)


def upgrade():
def upgrade(): # noqa: D103
# first check if the user already has this done. This should only be
# true for users who are upgrading from a previous version of Airflow
# that predates Alembic integration
Expand All @@ -65,5 +65,5 @@ def upgrade():
)


def downgrade():
def downgrade(): # noqa: D103
op.drop_column('connection', 'is_encrypted')
Expand Up @@ -33,9 +33,9 @@
depends_on = None


def upgrade():
def upgrade(): # noqa: D103
op.add_column('variable', sa.Column('is_encrypted', sa.Boolean, default=False))


def downgrade():
def downgrade(): # noqa: D103
op.drop_column('variable', 'is_encrypted')
4 changes: 2 additions & 2 deletions airflow/migrations/versions/1b38cef5b76e_add_dagrun.py
Expand Up @@ -34,7 +34,7 @@
depends_on = None


def upgrade():
def upgrade(): # noqa: D103
op.create_table('dag_run',
sa.Column('id', sa.Integer(), nullable=False),
sa.Column('dag_id', sa.String(length=250), nullable=True),
Expand All @@ -47,5 +47,5 @@ def upgrade():
sa.UniqueConstraint('dag_id', 'run_id'))


def downgrade():
def downgrade(): # noqa: D103
op.drop_table('dag_run')
Expand Up @@ -32,9 +32,9 @@
depends_on = None


def upgrade():
def upgrade(): # noqa: D103
op.create_index('ti_state', 'task_instance', ['state'], unique=False)


def downgrade():
def downgrade(): # noqa: D103
op.drop_index('ti_state', table_name='task_instance')
Expand Up @@ -38,9 +38,9 @@
NEW_COLUMN = "executor_config"


def upgrade():
def upgrade(): # noqa: D103
op.add_column(TASK_INSTANCE_TABLE, sa.Column(NEW_COLUMN, sa.PickleType(pickler=dill)))


def downgrade():
def downgrade(): # noqa: D103
op.drop_column(TASK_INSTANCE_TABLE, NEW_COLUMN)
4 changes: 2 additions & 2 deletions airflow/migrations/versions/2e541a1dcfed_task_duration.py
Expand Up @@ -35,7 +35,7 @@
depends_on = None


def upgrade():
def upgrade(): # noqa: D103
# use batch_alter_table to support SQLite workaround
with op.batch_alter_table("task_instance") as batch_op:
batch_op.alter_column('duration',
Expand All @@ -44,5 +44,5 @@ def upgrade():
existing_nullable=True)


def downgrade():
def downgrade(): # noqa: D103
pass
4 changes: 2 additions & 2 deletions airflow/migrations/versions/2e82aab8ef20_rename_user_table.py
Expand Up @@ -32,9 +32,9 @@
depends_on = None


def upgrade():
def upgrade(): # noqa: D103
op.rename_table('user', 'users')


def downgrade():
def downgrade(): # noqa: D103
op.rename_table('users', 'user')
Expand Up @@ -33,11 +33,11 @@
depends_on = None


def upgrade():
def upgrade(): # noqa: D103
op.add_column('task_instance', sa.Column('operator', sa.String(length=1000), nullable=True))
op.add_column('task_instance', sa.Column('queued_dttm', sa.DateTime(), nullable=True))


def downgrade():
def downgrade(): # noqa: D103
op.drop_column('task_instance', 'queued_dttm')
op.drop_column('task_instance', 'operator')
Expand Up @@ -35,7 +35,7 @@
RESOURCE_TABLE = "kube_resource_version"


def upgrade():
def upgrade(): # noqa: D103
columns_and_constraints = [
sa.Column("one_row_id", sa.Boolean, server_default=sa.true(), primary_key=True),
sa.Column("resource_version", sa.String(255))
Expand Down Expand Up @@ -63,5 +63,5 @@ def upgrade():
])


def downgrade():
def downgrade(): # noqa: D103
op.drop_table(RESOURCE_TABLE)
4 changes: 2 additions & 2 deletions airflow/migrations/versions/40e67319e3a9_dagrun_config.py
Expand Up @@ -33,9 +33,9 @@
depends_on = None


def upgrade():
def upgrade(): # noqa: D103
op.add_column('dag_run', sa.Column('conf', sa.PickleType(), nullable=True))


def downgrade():
def downgrade(): # noqa: D103
op.drop_column('dag_run', 'conf')
Expand Up @@ -33,9 +33,9 @@
depends_on = None


def upgrade():
def upgrade(): # noqa: D103
op.add_column('users', sa.Column('superuser', sa.Boolean(), default=False))


def downgrade():
def downgrade(): # noqa: D103
op.drop_column('users', 'superuser')

0 comments on commit 5d61580

Please sign in to comment.