ibis-bigquery
ibis-bigquery copied to clipboard
ibis-project
pydocstyle is failing
Run pydocstyle .
pydocstyle .
shell: /usr/bin/bash -e {0}
env:
pythonLocation: /opt/hostedtoolcache/Python/3.7.10/x64
LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/3.7.10/x64/lib
./ibis_bigquery/datatypes.py:1 at module level:
D100: Missing docstring in public module
./ibis_bigquery/datatypes.py:7 in public class `TypeTranslationContext`:
D205: 1 blank line required between summary line and description (found 0)
./ibis_bigquery/datatypes.py:7 in public class `TypeTranslationContext`:
D400: First line should end with a period (not 's')
./ibis_bigquery/datatypes.py:20 in public class `UDFContext`:
D101: Missing docstring in public class
./ibis_bigquery/datatypes.py:28 in public function `trans_string_default`:
D103: Missing docstring in public function
./ibis_bigquery/datatypes.py:33 in public function `trans_default`:
D103: Missing docstring in public function
./ibis_bigquery/datatypes.py:38 in public function `trans_string_context`:
D103: Missing docstring in public function
./ibis_bigquery/datatypes.py:43 in public function `trans_float64`:
D103: Missing docstring in public function
./ibis_bigquery/datatypes.py:48 in public function `trans_integer`:
D103: Missing docstring in public function
./ibis_bigquery/datatypes.py:53 in public function `trans_binary`:
D103: Missing docstring in public function
./ibis_bigquery/datatypes.py:60 in public function `trans_lossy_integer`:
D103: Missing docstring in public function
./ibis_bigquery/datatypes.py:67 in public function `trans_array`:
D103: Missing docstring in public function
./ibis_bigquery/datatypes.py:74 in public function `trans_struct`:
D103: Missing docstring in public function
./ibis_bigquery/datatypes.py:86 in public function `trans_date`:
D103: Missing docstring in public function
./ibis_bigquery/datatypes.py:91 in public function `trans_timestamp`:
D103: Missing docstring in public function
./ibis_bigquery/datatypes.py:98 in public function `trans_type`:
D103: Missing docstring in public function
./ibis_bigquery/datatypes.py:103 in public function `trans_integer_udf`:
D103: Missing docstring in public function
./ibis_bigquery/datatypes.py:114 in public function `trans_numeric`:
D103: Missing docstring in public function
./ibis_bigquery/datatypes.py:124 in public function `trans_numeric_udf`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:1 at module level:
D100: Missing docstring in public module
./ibis_bigquery/compiler.py:33 in public function `build_ast`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:38 in public class `BigQueryUDFNode`:
D101: Missing docstring in public class
./ibis_bigquery/compiler.py:42 in public class `BigQuerySelectBuilder`:
D101: Missing docstring in public class
./ibis_bigquery/compiler.py:48 in public class `BigQueryUDFDefinition`:
D101: Missing docstring in public class
./ibis_bigquery/compiler.py:53 in public method `compile`:
D102: Missing docstring in public method
./ibis_bigquery/compiler.py:57 in public class `BigQueryUnion`:
D101: Missing docstring in public class
./ibis_bigquery/compiler.py:59 in public method `keyword`:
D102: Missing docstring in public method
./ibis_bigquery/compiler.py:63 in public function `find_bigquery_udf`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:71 in public class `BigQueryQueryBuilder`:
D101: Missing docstring in public class
./ibis_bigquery/compiler.py:76 in public method `generate_setup_queries`:
D102: Missing docstring in public method
./ibis_bigquery/compiler.py:89 in public class `BigQueryContext`:
D101: Missing docstring in public class
./ibis_bigquery/compiler.py:113 in public function `bigquery_cast_timestamp_to_integer`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:118 in public function `bigquery_cast_generate`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:436 in public class `BigQueryExprTranslator`:
D101: Missing docstring in public class
./ibis_bigquery/compiler.py:454 in public function `bigquery_day_of_week_index`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:461 in public function `bigquery_day_of_week_name`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:467 in public function `bigquery_compiles_divide`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:472 in public function `compiles_strftime`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:491 in public function `compiles_string_to_timestamp`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:503 in public class `BigQueryTableSetFormatter`:
D101: Missing docstring in public class
./ibis_bigquery/compiler.py:510 in public class `BigQuerySelect`:
D101: Missing docstring in public class
./ibis_bigquery/compiler.py:515 in public method `table_set_formatter`:
D102: Missing docstring in public method
./ibis_bigquery/compiler.py:520 in public function `identical_to`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:526 in public function `log2`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:532 in public function `bq_sum`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:542 in public function `bq_mean`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:555 in public function `compiles_timestamp_from_unix`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:561 in public function `compiles_floor`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:568 in public function `compiles_approx`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:582 in public function `compiles_covar`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:610 in public function `bigquery_any_all_no_op`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:615 in public function `bigquery_compile_any`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:620 in public function `bigquery_compile_notany`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:627 in public function `bigquery_compile_all`:
D103: Missing docstring in public function
./ibis_bigquery/compiler.py:632 in public function `bigquery_compile_notall`:
D103: Missing docstring in public function
./ibis_bigquery/client.py:170 in public class `BigQueryQuery`:
D101: Missing docstring in public class
./ibis_bigquery/client.py:190 in public method `execute`:
D102: Missing docstring in public method
./ibis_bigquery/client.py:210 in public function `bq_param_struct`:
D103: Missing docstring in public function
./ibis_bigquery/client.py:217 in public function `bq_param_array`:
D103: Missing docstring in public function
./ibis_bigquery/client.py:245 in public function `bq_param_timestamp`:
D103: Missing docstring in public function
./ibis_bigquery/client.py:256 in public function `bq_param_string`:
D103: Missing docstring in public function
./ibis_bigquery/client.py:261 in public function `bq_param_integer`:
D103: Missing docstring in public function
./ibis_bigquery/client.py:266 in public function `bq_param_double`:
D103: Missing docstring in public function
./ibis_bigquery/client.py:271 in public function `bq_param_boolean`:
D103: Missing docstring in public function
./ibis_bigquery/client.py:276 in public function `bq_param_date_string`:
D103: Missing docstring in public function
./ibis_bigquery/client.py:281 in public function `bq_param_date_datetime`:
D103: Missing docstring in public function
./ibis_bigquery/client.py:286 in public function `bq_param_date`:
D103: Missing docstring in public function
./ibis_bigquery/client.py:290 in public class `BigQueryTable`:
D101: Missing docstring in public class
./ibis_bigquery/client.py:294 in public function `rename_partitioned_column`:
D103: Missing docstring in public function
./ibis_bigquery/client.py:423 in public method `project_id`:
D102: Missing docstring in public method
./ibis_bigquery/client.py:427 in public method `dataset_id`:
D102: Missing docstring in public method
./ibis_bigquery/client.py:430 in public method `table`:
D102: Missing docstring in public method
./ibis_bigquery/client.py:479 in public method `database`:
D102: Missing docstring in public method
./ibis_bigquery/client.py:489 in public method `current_database`:
D102: Missing docstring in public method
./ibis_bigquery/client.py:492 in public method `set_database`:
D102: Missing docstring in public method
./ibis_bigquery/client.py:495 in public method `exists_database`:
D102: Missing docstring in public method
./ibis_bigquery/client.py:506 in public method `list_databases`:
D102: Missing docstring in public method
./ibis_bigquery/client.py:520 in public method `exists_table`:
D102: Missing docstring in public method
./ibis_bigquery/client.py:532 in public method `list_tables`:
D102: Missing docstring in public method
./ibis_bigquery/client.py:546 in public method `get_schema`:
D102: Missing docstring in public method
./ibis_bigquery/client.py:553 in public method `version`:
D102: Missing docstring in public method
./ibis_bigquery/__init__.py:39 in public class `Backend`:
D101: Missing docstring in public class
./ibis_bigquery/__init__.py:143 in public method `register_options`:
D102: Missing docstring in public method
./ibis_bigquery/udf/rewrite.py:1 at module level:
D100: Missing docstring in public module
./ibis_bigquery/udf/rewrite.py:46 in public method `register`:
D102: Missing docstring in public method
./ibis_bigquery/udf/rewrite.py:53 in public method `__call__`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:1 at module level:
D200: One-line docstring should fit on one line with quotes (found 2)
./ibis_bigquery/udf/core.py:1 at module level:
D400: First line should end with a period (not 't')
./ibis_bigquery/udf/core.py:27 in public method `__getitem__`:
D105: Missing docstring in magic method
./ibis_bigquery/udf/core.py:70 in public function `rewrite_print`:
D103: Missing docstring in public function
./ibis_bigquery/udf/core.py:83 in public function `rewrite_len`:
D103: Missing docstring in public function
./ibis_bigquery/udf/core.py:89 in public function `rewrite_append`:
D103: Missing docstring in public function
./ibis_bigquery/udf/core.py:100 in public function `rewrite_array_from`:
D103: Missing docstring in public function
./ibis_bigquery/udf/core.py:108 in public class `PythonToJavaScriptTranslator`:
D101: Missing docstring in public class
./ibis_bigquery/udf/core.py:133 in public method `compile`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:136 in public method `visit`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:150 in public method `visit_Name`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:155 in public method `visit_Yield`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:159 in public method `visit_YieldFrom`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:164 in public method `visit_Assign`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:189 in public method `translate_special_method`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:192 in public method `visit_FunctionDef`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:232 in public method `visit_Return`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:235 in public method `visit_Add`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:238 in public method `visit_Sub`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:241 in public method `visit_Mult`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:244 in public method `visit_Div`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:247 in public method `visit_FloorDiv`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:250 in public method `visit_Pow`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:253 in public method `visit_UnaryOp`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:256 in public method `visit_USub`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:259 in public method `visit_UAdd`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:262 in public method `visit_BinOp`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:277 in public method `visit_NameConstant`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:290 in public method `visit_Str`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:293 in public method `visit_Num`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:296 in public method `visit_List`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:299 in public method `visit_Tuple`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:303 in public method `visit_Dict`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:312 in public method `visit_Expr`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:315 in public method `visit_Starred`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:318 in public method `visit_Call`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:330 in public method `visit_Attribute`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:333 in public method `visit_For`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:344 in public method `visit_While`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:352 in public method `visit_Break`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:356 in public method `visit_Continue`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:359 in public method `visit_Eq`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:362 in public method `visit_NotEq`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:365 in public method `visit_Or`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:368 in public method `visit_And`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:371 in public method `visit_BoolOp`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:378 in public method `visit_Lt`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:381 in public method `visit_LtE`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:384 in public method `visit_Gt`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:387 in public method `visit_GtE`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:390 in public method `visit_Compare`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:406 in public method `visit_AugAssign`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:413 in public method `visit_Module`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:416 in public method `visit_arg`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:421 in public method `visit_arguments`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:428 in public method `visit_Lambda`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:435 in public method `local_scope`:
D200: One-line docstring should fit on one line with quotes (found 2)
./ibis_bigquery/udf/core.py:443 in public method `visit_If`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:457 in public method `visit_IfExp`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:464 in public method `visit_Index`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:467 in public method `visit_Subscript`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:470 in public method `visit_ClassDef`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:486 in public method `visit_Not`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:490 in public method `visit_ListComp`:
D400: First line should end with a period (not 'n')
./ibis_bigquery/udf/core.py:539 in public method `visit_Delete`:
D102: Missing docstring in public method
./ibis_bigquery/udf/core.py:553 in public function `my_func`:
D103: Missing docstring in public function
./ibis_bigquery/udf/find.py:1 at module level:
D100: Missing docstring in public module
./ibis_bigquery/udf/find.py:7 in public class `NameFinder`:
D200: One-line docstring should fit on one line with quotes (found 2)
./ibis_bigquery/udf/find.py:12 in public method `find`:
D102: Missing docstring in public method
./ibis_bigquery/udf/find.py:27 in public method `find_Name`:
D102: Missing docstring in public method
./ibis_bigquery/udf/find.py:31 in public method `find_list`:
D102: Missing docstring in public method
./ibis_bigquery/udf/find.py:34 in public method `find_Call`:
D102: Missing docstring in public method
./ibis_bigquery/udf/__init__.py:1 at module level:
D104: Missing docstring in public package
./ibis_bigquery/udf/__init__.py:42 in public function `udf`:
D400: First line should end with a period (not 'y')
./tests/conftest.py:1 at module level:
D100: Missing docstring in public module
./tests/conftest.py:48 in public class `TestConf`:
D101: Missing docstring in public class
./tests/conftest.py:54 in public method `connect`:
D102: Missing docstring in public method
./tests/conftest.py:72 in public method `batting`:
D102: Missing docstring in public method
./tests/conftest.py:76 in public method `awards_players`:
D102: Missing docstring in public method
./tests/conftest.py:81 in public function `project_id`:
D103: Missing docstring in public function
./tests/conftest.py:86 in public function `credentials`:
D103: Missing docstring in public function
./tests/conftest.py:91 in public function `client`:
D103: Missing docstring in public function
./tests/conftest.py:98 in public function `client2`:
D103: Missing docstring in public function
./tests/conftest.py:105 in public function `alltypes`:
D103: Missing docstring in public function
./tests/conftest.py:110 in public function `df`:
D103: Missing docstring in public function
./tests/conftest.py:115 in public function `parted_alltypes`:
D103: Missing docstring in public function
./tests/conftest.py:120 in public function `parted_df`:
D103: Missing docstring in public function
./tests/conftest.py:125 in public function `struct_table`:
D103: Missing docstring in public function
./tests/conftest.py:130 in public function `numeric_table`:
D103: Missing docstring in public function
./tests/conftest.py:135 in public function `public`:
D103: Missing docstring in public function
./tests/__init__.py:1 at module level:
D104: Missing docstring in public package
./tests/udf/__init__.py:1 at module level:
D104: Missing docstring in public package
Error: Process completed with exit code 1.
hey @tswast what is really the problem here? is it really just missing all the docstring ? if so, do we have a pattern that we'd like to follow?
@renato2099 Yeah, a bunch of missing docstrings. I'm undecided if it's worth adding all of these, as I expect most people will be referring to the actual ibis docs for most of this.
The other thing is that there are probably a lot of functions that are considered public that maybe shouldn't be. I honestly was going to wait on this issue until at least we were building a documentation set and could have a clearer idea about what is "public" and what is "private"