Use __all__ for public API exports (#1551)

roll · web-flow · commit 30b9215e78f3 · 2023-07-03T14:11:59.000+01:00
* Added top-level alls

* Added alls to nested public modules
diff --git a/frictionless/__init__.py b/frictionless/__init__.py
@@ -20,3 +20,49 @@
 from .table import Header, Lookup, Row
 from .transformer import Transformer
 from .validator import Validator
+
+__all__ = [
+    "Adapter"
+    "Analyzer"
+    "Catalog"
+    "Check"
+    "Checklist"
+    "Control"
+    "Dataset"
+    "Detector"
+    "Dialect"
+    "Error"
+    "Field"
+    "FrictionlessException"
+    "Header"
+    "Indexer"
+    "Inquiry"
+    "InquiryTask"
+    "Loader"
+    "Lookup"
+    "Mapper"
+    "Metadata"
+    "Package"
+    "Parser"
+    "Pipeline"
+    "Platform"
+    "Plugin"
+    "Report"
+    "ReportTask"
+    "Resource"
+    "Row"
+    "Schema"
+    "Step"
+    "System"
+    "Transformer"
+    "Validator"
+    "convert"
+    "describe"
+    "extract"
+    "index"
+    "list"
+    "platform"
+    "system"
+    "transform"
+    "validate"
+]
diff --git a/frictionless/checks/__init__.py b/frictionless/checks/__init__.py
@@ -2,3 +2,17 @@
 from .cell import *
 from .row import *
 from .table import *
+
+__all__ = [
+    "ascii_value"
+    "baseline"
+    "deviated_cell"
+    "deviated_value"
+    "duplicate_row"
+    "forbidden_value"
+    "required_value"
+    "row_constraint"
+    "sequential_value"
+    "table_dimensions"
+    "truncated_value"
+]
diff --git a/frictionless/errors/__init__.py b/frictionless/errors/__init__.py
@@ -7,3 +7,66 @@
 from .resource import *
 from .row import *
 from .table import *
+
+__all__ = [
+    "AsciiValueError"
+    "BlankHeaderError"
+    "BlankLabelError"
+    "BlankRowError"
+    "ByteCountError"
+    "CatalogError"
+    "CellError"
+    "CheckError"
+    "ChecklistError"
+    "CompressionError"
+    "ConstraintError"
+    "ControlError"
+    "DataError"
+    "DatasetError"
+    "DetectorError"
+    "DeviatedCellError"
+    "DeviatedValueError"
+    "DialectError"
+    "DuplicateLabelError"
+    "DuplicateRowError"
+    "EncodingError"
+    "ExtraCellError"
+    "ExtraLabelError"
+    "FieldCountError"
+    "FieldError"
+    "FileError"
+    "ForbiddenValueError"
+    "ForeignKeyError"
+    "FormatError"
+    "FrictionlessException"
+    "HashCountError"
+    "HeaderError"
+    "IncorrectLabelError"
+    "InquiryError"
+    "InquiryTaskError"
+    "LabelError"
+    "MetadataError"
+    "MissingCellError"
+    "MissingLabelError"
+    "PackageError"
+    "PipelineError"
+    "PrimaryKeyError"
+    "ReportError"
+    "ReportTaskError"
+    "RequiredValueError"
+    "ResourceError"
+    "RowConstraintError"
+    "RowCountError"
+    "RowError"
+    "SchemaError"
+    "SchemeError"
+    "SequentialValueError"
+    "SourceError"
+    "StatsError"
+    "StepError"
+    "TableDimensionsError"
+    "TableError"
+    "TruncatedValueError"
+    "TypeError"
+    "UniqueError"
+]
diff --git a/frictionless/fields/__init__.py b/frictionless/fields/__init__.py
@@ -13,3 +13,21 @@
 from .time import TimeField
 from .year import YearField
 from .yearmonth import YearmonthField
+
+__all__ = [
+    "AnyField"
+    "ArrayField"
+    "BooleanField"
+    "DateField"
+    "DatetimeField"
+    "DurationField"
+    "GeojsonField"
+    "GeopointField"
+    "IntegerField"
+    "NumberField"
+    "ObjectField"
+    "StringField"
+    "TimeField"
+    "YearField"
+    "YearmonthField"
+]
diff --git a/frictionless/formats/csv/__init__.py b/frictionless/formats/csv/__init__.py
@@ -1,3 +1,9 @@
 from .control import CsvControl
 from .parser import CsvParser
 from .plugin import CsvPlugin
+
+__all__ = [
+    "CsvControl",
+    "CsvParser",
+    "CsvPlugin",
+]
diff --git a/frictionless/formats/document/__init__.py b/frictionless/formats/document/__init__.py
@@ -1 +1,5 @@
 from .plugin import DocumentPlugin
+
+__all__ = [
+    "DocumentPlugin",
+]
diff --git a/frictionless/formats/erd/__init__.py b/frictionless/formats/erd/__init__.py
@@ -1 +1,5 @@
 from .mapper import ErdMapper
+
+__all__ = [
+    "ErdMapper",
+]
diff --git a/frictionless/formats/excel/__init__.py b/frictionless/formats/excel/__init__.py
@@ -3,3 +3,12 @@
 from .mapper import ExcelMapper
 from .parsers import XlsParser, XlsxParser
 from .plugin import ExcelPlugin
+
+__all__ = [
+    "ExcelAdapter",
+    "ExcelControl",
+    "ExcelMapper",
+    "ExcelPlugin",
+    "XlsParser",
+    "XlsxParser",
+]
diff --git a/frictionless/formats/gsheets/__init__.py b/frictionless/formats/gsheets/__init__.py
@@ -1,3 +1,9 @@
 from .control import GsheetsControl
 from .parser import GsheetsParser
 from .plugin import GsheetsPlugin
+
+__all__ = [
+    "GsheetsControl",
+    "GsheetsParser",
+    "GsheetsPlugin",
+]
diff --git a/frictionless/formats/html/__init__.py b/frictionless/formats/html/__init__.py
@@ -1,3 +1,9 @@
 from .control import HtmlControl
 from .parser import HtmlParser
 from .plugin import HtmlPlugin
+
+__all__ = [
+    "HtmlControl",
+    "HtmlParser",
+    "HtmlPlugin",
+]
diff --git a/frictionless/formats/image/__init__.py b/frictionless/formats/image/__init__.py
@@ -1 +1,5 @@
 from .plugin import ImagePlugin
+
+__all__ = [
+    "ImagePlugin",
+]
diff --git a/frictionless/formats/inline/__init__.py b/frictionless/formats/inline/__init__.py
@@ -1,3 +1,9 @@
 from .control import InlineControl
 from .parser import InlineParser
 from .plugin import InlinePlugin
+
+__all__ = [
+    "InlineControl",
+    "InlineParser",
+    "InlinePlugin",
+]
diff --git a/frictionless/formats/json/__init__.py b/frictionless/formats/json/__init__.py
@@ -1,3 +1,10 @@
 from .control import JsonControl
 from .parsers import JsonlParser, JsonParser
 from .plugin import JsonPlugin
+
+__all__ = [
+    "JsonControl",
+    "JsonParser",
+    "JsonPlugin",
+    "JsonlParser",
+]
diff --git a/frictionless/formats/jsonschema/__init__.py b/frictionless/formats/jsonschema/__init__.py
@@ -1 +1,5 @@
 from .mapper import JsonschemaMapper
+
+__all__ = [
+    "JsonschemaMapper",
+]
diff --git a/frictionless/formats/markdown/__init__.py b/frictionless/formats/markdown/__init__.py
@@ -1,2 +1,7 @@
 from .mapper import MarkdownMapper
 from .plugin import MarkdownPlugin
+
+__all__ = [
+    "MarkdownMapper",
+    "MarkdownPlugin",
+]
diff --git a/frictionless/formats/ods/__init__.py b/frictionless/formats/ods/__init__.py
@@ -2,3 +2,10 @@
 from .control import OdsControl
 from .parser import OdsParser
 from .plugin import OdsPlugin
+
+__all__ = [
+    "OdsAdapter",
+    "OdsControl",
+    "OdsParser",
+    "OdsPlugin",
+]
diff --git a/frictionless/formats/pandas/__init__.py b/frictionless/formats/pandas/__init__.py
@@ -1,3 +1,9 @@
 from .control import PandasControl
 from .parser import PandasParser
 from .plugin import PandasPlugin
+
+__all__ = [
+    "PandasControl",
+    "PandasParser",
+    "PandasPlugin",
+]
diff --git a/frictionless/formats/parquet/__init__.py b/frictionless/formats/parquet/__init__.py
@@ -1,3 +1,9 @@
 from .control import ParquetControl
 from .parser import ParquetParser
 from .plugin import ParquetPlugin
+
+__all__ = [
+    "ParquetControl",
+    "ParquetParser",
+    "ParquetPlugin",
+]
diff --git a/frictionless/formats/python/__init__.py b/frictionless/formats/python/__init__.py
@@ -1 +1,5 @@
 from .plugin import PythonPlugin
+
+__all__ = [
+    "PythonPlugin",
+]
diff --git a/frictionless/formats/qsv/__init__.py b/frictionless/formats/qsv/__init__.py
@@ -1,2 +1,7 @@
 from .adapter import QsvAdapter
 from .mapper import QsvMapper
+
+__all__ = [
+    "QsvAdapter",
+    "QsvMapper",
+]
diff --git a/frictionless/formats/spss/__init__.py b/frictionless/formats/spss/__init__.py
@@ -1,3 +1,9 @@
 from .control import SpssControl
 from .parser import SpssParser
 from .plugin import SpssPlugin
+
+__all__ = [
+    "SpssControl",
+    "SpssParser",
+    "SpssPlugin",
+]
diff --git a/frictionless/formats/sql/__init__.py b/frictionless/formats/sql/__init__.py
@@ -3,3 +3,11 @@
 from .mapper import SqlMapper
 from .parser import SqlParser
 from .plugin import SqlPlugin
+
+__all__ = [
+    "SqlAdapter",
+    "SqlControl",
+    "SqlMapper",
+    "SqlParser",
+    "SqlPlugin",
+]
diff --git a/frictionless/formats/text/__init__.py b/frictionless/formats/text/__init__.py
@@ -1 +1,5 @@
 from .plugin import TextPlugin
+
+__all__ = [
+    "TextPlugin",
+]
diff --git a/frictionless/formats/yaml/__init__.py b/frictionless/formats/yaml/__init__.py
@@ -1,3 +1,9 @@
 from .control import YamlControl
 from .parser import YamlParser
 from .plugin import YamlPlugin
+
+__all__ = [
+    "YamlControl",
+    "YamlParser",
+    "YamlPlugin",
+]
diff --git a/frictionless/formats/zip/__init__.py b/frictionless/formats/zip/__init__.py
@@ -1,3 +1,9 @@
 from .adapter import ZipAdapter
 from .control import ZipControl
 from .plugin import ZipPlugin
+
+__all__ = [
+    "ZipAdapter",
+    "ZipControl",
+    "ZipPlugin",
+]
diff --git a/frictionless/portals/ckan/__init__.py b/frictionless/portals/ckan/__init__.py
@@ -1,3 +1,9 @@
 from .adapter import CkanAdapter
 from .control import CkanControl
 from .plugin import CkanPlugin
+
+__all__ = [
+    "CkanAdapter",
+    "CkanControl",
+    "CkanPlugin",
+]
diff --git a/frictionless/portals/github/__init__.py b/frictionless/portals/github/__init__.py
@@ -1,3 +1,9 @@
 from .adapter import GithubAdapter
 from .control import GithubControl
 from .plugin import GithubPlugin
+
+__all__ = [
+    "GithubAdapter",
+    "GithubControl",
+    "GithubPlugin",
+]
diff --git a/frictionless/portals/zenodo/__init__.py b/frictionless/portals/zenodo/__init__.py
@@ -1,3 +1,9 @@
 from .adapter import ZenodoAdapter
 from .control import ZenodoControl
 from .plugin import ZenodoPlugin
+
+__all__ = [
+    "ZenodoAdapter",
+    "ZenodoControl",
+    "ZenodoPlugin",
+]
diff --git a/frictionless/resources/__init__.py b/frictionless/resources/__init__.py
diff --git a/frictionless/schemes/aws/__init__.py b/frictionless/schemes/aws/__init__.py
diff --git a/frictionless/schemes/buffer/__init__.py b/frictionless/schemes/buffer/__init__.py
diff --git a/frictionless/schemes/local/__init__.py b/frictionless/schemes/local/__init__.py
diff --git a/frictionless/schemes/multipart/__init__.py b/frictionless/schemes/multipart/__init__.py
diff --git a/frictionless/schemes/remote/__init__.py b/frictionless/schemes/remote/__init__.py
diff --git a/frictionless/schemes/stream/__init__.py b/frictionless/schemes/stream/__init__.py
diff --git a/frictionless/steps/__init__.py b/frictionless/steps/__init__.py
diff --git a/pyproject.toml b/pyproject.toml
