Add comprehensive docstrings and expand API documentation#632
Merged
laughingman7743 merged 3 commits intomasterfrom Jan 1, 2026
Merged
Add comprehensive docstrings and expand API documentation#632laughingman7743 merged 3 commits intomasterfrom
laughingman7743 merged 3 commits intomasterfrom
Conversation
Add documentation for: - Model classes: AthenaCalculationExecutionStatus, AthenaCalculationExecution, AthenaSessionStatus, AthenaDatabase, AthenaTableMetadataColumn, AthenaTableMetadataPartitionKey, AthenaTableMetadata, AthenaRowFormatSerde, AthenaPartitionTransform - Result set classes: AthenaResultSet, DataFrameIterator - SQLAlchemy dialects: AthenaDialect, AthenaArrowDialect, AthenaPandasDialect, AthenaRestDialect - S3FS converter: DefaultS3FSTypeConverter.convert method Closes #595 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Add documentation for: - Compiler classes: AthenaTypeCompiler, AthenaStatementCompiler, AthenaDDLCompiler - Preparer classes: AthenaDMLIdentifierPreparer, AthenaDDLIdentifierPreparer - Type classes: AthenaTimestamp, AthenaDate, Tinyint, TINYINT, AthenaStruct, STRUCT, AthenaMap, MAP, AthenaArray, ARRAY - Utility classes: _HashableDict - Module docstring for util.py 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add docstrings to pyathena/pandas/util.py functions: - get_chunks, reset_index, as_pandas, to_sql_type_mappings - to_parquet, to_sql, get_column_names_and_types, generate_ddl - Add docstrings to pyathena/arrow/util.py functions: - to_column_info, get_athena_type - Add module docstrings to both utility files - Add missing classes to Sphinx API documentation: - AthenaPandasResultSet, DataFrameIterator in pandas.rst - AthenaArrowResultSet in arrow.rst - AthenaResultSet, AthenaDictResultSet, WithResultSet in connection.rst - S3File in filesystem.rst - Create new docs/api/sqlalchemy.rst for SQLAlchemy integration: - Dialects, Type System, Compilers, Identifier Preparers - Update docs/api.rst to include SQLAlchemy reference 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
laughingman7743
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
pyathena/model.pyAthenaResultSet,DataFrameIterator)pyathena/pandas/util.py,pyathena/arrow/util.py)Classes documented:
Model classes:
AthenaCalculationExecutionStatus,AthenaCalculationExecutionAthenaSessionStatus,AthenaDatabaseAthenaTableMetadataColumn,AthenaTableMetadataPartitionKey,AthenaTableMetadataAthenaRowFormatSerde,AthenaPartitionTransformResult set classes:
AthenaResultSet,AthenaDictResultSet,WithResultSet(base classes)AthenaPandasResultSet,DataFrameIterator(pandas)AthenaArrowResultSet(arrow)SQLAlchemy classes:
AthenaDialect,AthenaArrowDialect,AthenaPandasDialect,AthenaRestDialectAthenaTypeCompiler,AthenaStatementCompiler,AthenaDDLCompilerAthenaDMLIdentifierPreparer,AthenaDDLIdentifierPreparerAthenaTimestamp,AthenaDate,Tinyint,TINYINTAthenaStruct,STRUCT,AthenaMap,MAP,AthenaArray,ARRAY_HashableDictS3FS classes:
DefaultS3FSTypeConverter.convertmethodUtility functions:
pyathena/pandas/util.py:get_chunks,reset_index,as_pandas,to_sql_type_mappings,to_parquet,to_sql,get_column_names_and_types,generate_ddlpyathena/arrow/util.py:to_column_info,get_athena_typeSphinx API documentation updates:
docs/api/sqlalchemy.rstfor SQLAlchemy integration (dialects, types, compilers, preparers)docs/api/connection.rstAthenaPandasResultSet,DataFrameIterator, utility functions todocs/api/pandas.rstAthenaArrowResultSet, utility functions todocs/api/arrow.rstS3Filetodocs/api/filesystem.rstdocs/api.rstto include SQLAlchemy referenceTest plan
make chkpasses (lint, format, mypy)Closes #595
🤖 Generated with Claude Code