Enable pydocstyle rules

examples/advanced_usage/auto_hyperlinks.py

@@ -7,9 +7,7 @@
 def extract_url_byte_positions(
     text: str, *, aggressive: bool, encoding: str = 'UTF-8'
 ) -> t.List[t.Tuple[str, int, int]]:
-    """
-    If aggressive is False, only links beginning http or https will be detected
-    """
+    """If aggressive is False, only links beginning http or https will be detected"""
     encoded_text = text.encode(encoding)
 
     if aggressive:

fetch_new_lexicon.py

@@ -1,3 +1,4 @@
+"""Fetch lexicons from the latest commit and writes them to the lexicons folder."""
 import typing as t
 import zipfile
 from io import BytesIO
@@ -108,6 +109,7 @@ def _remove_all_files_from_lexicons_folder() -> None:
 
 
 def main() -> None:
+    """Fetch lexicons from the latest commit and writes them to the lexicons folder."""
     sha, commit_date, _ = _get_last_commit_info()
 
     # FIXME(MarshalX): the script doesn't care about deleted lexicons

packages/atproto_cli/cli.py

@@ -8,7 +8,7 @@
 
 
 class AliasedGroup(click.Group):
-    """Ref: https://click.palletsprojects.com/en/8.1.x/advanced/"""
+    """Ref: https://click.palletsprojects.com/en/8.1.x/advanced/."""
 
     def get_command(self, ctx: click.Context, cmd_name: str) -> t.Optional[click.Command]:
         rv = click.Group.get_command(self, ctx, cmd_name)
@@ -40,7 +40,7 @@ def resolve_command(
 @click.group(cls=AliasedGroup)
 @click.pass_context
 def atproto_cli(ctx: click.Context) -> None:
-    """CLI of AT Protocol SDK for Python"""
+    """CLI of AT Protocol SDK for Python."""
     ctx.ensure_object(dict)
 
 

packages/atproto_client/client/async_client.py

@@ -163,7 +163,6 @@ async def delete_post(self, post_uri: str) -> bool:
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         uri = AtUri.from_str(post_uri)
         return await self.com.atproto.repo.delete_record(
             models.ComAtprotoRepoDeleteRecord.Data(
@@ -203,7 +202,6 @@ async def send_image(
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         upload = await self.com.atproto.repo.upload_blob(image)
         images = [models.AppBskyEmbedImages.Image(alt=image_alt, image=upload.blob)]
         return await self.send_post(
@@ -231,7 +229,6 @@ async def get_post(
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         repo = self.me.did
         if profile_identify:
             repo = profile_identify
@@ -262,7 +259,6 @@ async def get_posts(self, uris: t.List[str]) -> models.AppBskyFeedGetPosts.Respo
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         return await self.app.bsky.feed.get_posts(
             models.AppBskyFeedGetPosts.Params(
                 uris=uris,
@@ -276,14 +272,15 @@ async def get_post_thread(
 
         Args:
             uri: AT URI.
+            depth: Depth of the thread.
+            parent_height: Height of the parent post.
 
         Returns:
             :obj:`models.AppBskyFeedGetPostThread.Response`: Post thread.
 
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         return await self.app.bsky.feed.get_post_thread(
             models.AppBskyFeedGetPostThread.Params(
                 uri=uri,
@@ -309,7 +306,6 @@ async def get_likes(
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         return await self.app.bsky.feed.get_likes(
             models.AppBskyFeedGetLikes.Params(uri=uri, cid=cid, cursor=cursor, limit=limit)
         )
@@ -331,7 +327,6 @@ async def get_reposted_by(
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         return await self.app.bsky.feed.get_reposted_by(
             models.AppBskyFeedGetRepostedBy.Params(uri=uri, cid=cid, cursor=cursor, limit=limit)
         )
@@ -352,7 +347,6 @@ async def get_timeline(
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         return await self.app.bsky.feed.get_timeline(
             models.AppBskyFeedGetTimeline.Params(algorithm=algorithm, cursor=cursor, limit=limit)
         )
@@ -374,7 +368,6 @@ async def get_author_feed(
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         return await self.app.bsky.feed.get_author_feed(
             models.AppBskyFeedGetAuthorFeed.Params(actor=actor, cursor=cursor, fitler=filter, limit=limit)
         )
@@ -391,7 +384,6 @@ async def like(self, subject: models.ComAtprotoRepoStrongRef.Main) -> models.Com
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         return await self.com.atproto.repo.create_record(
             models.ComAtprotoRepoCreateRecord.Data(
                 repo=self.me.did,
@@ -412,7 +404,6 @@ async def unlike(self, like_uri: str) -> bool:
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         uri = AtUri.from_str(like_uri)
         return await self.com.atproto.repo.delete_record(
             models.ComAtprotoRepoDeleteRecord.Data(
@@ -437,7 +428,6 @@ async def repost(
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         return await self.com.atproto.repo.create_record(
             models.ComAtprotoRepoCreateRecord.Data(
                 repo=self.me.did,
@@ -461,7 +451,6 @@ async def unrepost(self, repost_uri: str) -> bool:
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         uri = AtUri.from_str(repost_uri)
         return await self.com.atproto.repo.delete_record(
             models.ComAtprotoRepoDeleteRecord.Data(
@@ -483,7 +472,6 @@ async def follow(self, subject: str) -> models.ComAtprotoRepoCreateRecord.Respon
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         return await self.com.atproto.repo.create_record(
             models.ComAtprotoRepoCreateRecord.Data(
                 repo=self.me.did,
@@ -504,7 +492,6 @@ async def unfollow(self, follow_uri: str) -> bool:
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         uri = AtUri.from_str(follow_uri)
         return await self.com.atproto.repo.delete_record(
             models.ComAtprotoRepoDeleteRecord.Data(
@@ -530,7 +517,6 @@ async def get_follows(
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         return await self.app.bsky.graph.get_follows(
             models.AppBskyGraphGetFollows.Params(actor=actor, cursor=cursor, limit=limit)
         )
@@ -551,7 +537,6 @@ async def get_followers(
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         return await self.app.bsky.graph.get_followers(
             models.AppBskyGraphGetFollowers.Params(actor=actor, cursor=cursor, limit=limit)
         )
@@ -568,7 +553,6 @@ async def get_profile(self, actor: str) -> models.AppBskyActorDefs.ProfileViewDe
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         return await self.app.bsky.actor.get_profile(models.AppBskyActorGetProfile.Params(actor=actor))
 
     async def get_profiles(self, actors: t.List[str]) -> models.AppBskyActorGetProfiles.Response:
@@ -583,7 +567,6 @@ async def get_profiles(self, actors: t.List[str]) -> models.AppBskyActorGetProfi
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         return await self.app.bsky.actor.get_profiles(models.AppBskyActorGetProfiles.Params(actors=actors))
 
     async def mute(self, actor: str) -> bool:
@@ -598,7 +581,6 @@ async def mute(self, actor: str) -> bool:
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         return await self.app.bsky.graph.mute_actor(models.AppBskyGraphMuteActor.Data(actor=actor))
 
     async def unmute(self, actor: str) -> bool:
@@ -613,7 +595,6 @@ async def unmute(self, actor: str) -> bool:
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         return await self.app.bsky.graph.unmute_actor(models.AppBskyGraphUnmuteActor.Data(actor=actor))
 
     async def resolve_handle(self, handle: str) -> models.ComAtprotoIdentityResolveHandle.Response:
@@ -628,7 +609,6 @@ async def resolve_handle(self, handle: str) -> models.ComAtprotoIdentityResolveH
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         return await self.com.atproto.identity.resolve_handle(
             models.ComAtprotoIdentityResolveHandle.Params(handle=handle)
         )
@@ -645,7 +625,6 @@ async def update_handle(self, handle: str) -> bool:
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         return await self.com.atproto.identity.update_handle(models.ComAtprotoIdentityUpdateHandle.Data(handle=handle))
 
     async def upload_blob(self, data: bytes) -> models.ComAtprotoRepoUploadBlob.Response:
@@ -660,7 +639,6 @@ async def upload_blob(self, data: bytes) -> models.ComAtprotoRepoUploadBlob.Resp
         Raises:
             :class:`atproto.exceptions.AtProtocolError`: Base exception.
         """
-
         return await self.com.atproto.repo.upload_blob(data)
 
     #: Alias for :attr:`unfollow`

packages/atproto_client/client/async_raw.py

@@ -7,7 +7,7 @@
 
 
 class AsyncClientRaw(AsyncClientBase):
-    """Group all root namespaces"""
+    """Group all root namespaces."""
 
     com: 'async_ns.ComNamespace'
     app: 'async_ns.AppNamespace'

packages/atproto_client/client/base.py

@@ -22,7 +22,7 @@ class InvokeType(Enum):
 
 
 def _handle_kwagrs(kwargs: dict) -> None:
-    """Mutates input data"""
+    """Mutates input data."""
     content_type = _DEFAULT_CONTENT_TYPE
 
     if 'headers' not in kwargs:
@@ -45,7 +45,7 @@ def _handle_kwagrs(kwargs: dict) -> None:
 
 
 class ClientBase:
-    """Low-level methods are here"""
+    """Low-level methods are here."""
 
     def __init__(self, base_url: t.Optional[str] = None, request: t.Optional[Request] = None) -> None:
         if request is None:
@@ -90,7 +90,7 @@ def _invoke(self, invoke_type: InvokeType, **kwargs: t.Any) -> Response:
 
 
 class AsyncClientBase:
-    """Low-level methods are here"""
+    """Low-level methods are here."""
 
     def __init__(self, base_url: t.Optional[str] = None, request: t.Optional[AsyncRequest] = None) -> None:
         if request is None: