mirror
/
Mastodon.py
kopia lustrzana https://github.com/halcy/Mastodon.py
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Update and fix docs

pull/397/head
halcy 2025-02-14 20:51:25 +02:00
rodzic 8586462c6c
commit f44cba479c
4 zmienionych plików z 703 dodań i 580 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

357
docs/02_return_values.rst
Wyświetl plik

@ -55,109 +55,73 @@ Base types
Return types Return types
============ ============
.. autoclass:: mastodon.return_types.WebPushSubscriptionAlerts .. autoclass:: mastodon.return_types.Account
:members: :members:
.. autoclass:: mastodon.return_types.WebPushSubscription .. autoclass:: mastodon.return_types.AccountField
:members:
.. autoclass:: mastodon.return_types.UserList
:members:
.. autoclass:: mastodon.return_types.Translation
:members:
.. autoclass:: mastodon.return_types.TagHistory
:members:
.. autoclass:: mastodon.return_types.Tag
:members:
.. autoclass:: mastodon.return_types.Suggestion
:members:
.. autoclass:: mastodon.return_types.StreamReaction
:members:
.. autoclass:: mastodon.return_types.StatusSource
:members:
.. autoclass:: mastodon.return_types.StatusMention
:members:
.. autoclass:: mastodon.return_types.StatusEdit
:members:
.. autoclass:: mastodon.return_types.Status
:members:
.. autoclass:: mastodon.return_types.SearchV2
:members:
.. autoclass:: mastodon.return_types.Search
:members:
.. autoclass:: mastodon.return_types.ScheduledStatusParams
:members:
.. autoclass:: mastodon.return_types.ScheduledStatus
:members:
.. autoclass:: mastodon.return_types.Rule
:members: :members:
.. autoclass:: mastodon.return_types.Role .. autoclass:: mastodon.return_types.Role
:members: :members:
.. autoclass:: mastodon.return_types.Report .. autoclass:: mastodon.return_types.CredentialAccountSource
:members: :members:
.. autoclass:: mastodon.return_types.Relationship .. autoclass:: mastodon.return_types.Status
:members: :members:
.. autoclass:: mastodon.return_types.Reaction .. autoclass:: mastodon.return_types.StatusEdit
:members: :members:
.. autoclass:: mastodon.return_types.PushNotification .. autoclass:: mastodon.return_types.FilterResult
:members: :members:
.. autoclass:: mastodon.return_types.PreviewCardAuthor .. autoclass:: mastodon.return_types.StatusMention
:members: :members:
.. autoclass:: mastodon.return_types.PreviewCard .. autoclass:: mastodon.return_types.ScheduledStatus
:members: :members:
.. autoclass:: mastodon.return_types.Preferences .. autoclass:: mastodon.return_types.ScheduledStatusParams
:members:
.. autoclass:: mastodon.return_types.PollOption
:members: :members:
.. autoclass:: mastodon.return_types.Poll .. autoclass:: mastodon.return_types.Poll
:members: :members:
.. autoclass:: mastodon.return_types.PollOption
:members:
.. autoclass:: mastodon.return_types.Conversation
:members:
.. autoclass:: mastodon.return_types.Tag
:members:
.. autoclass:: mastodon.return_types.TagHistory
:members:
.. autoclass:: mastodon.return_types.CustomEmoji
:members:
.. autoclass:: mastodon.return_types.Application
:members:
.. autoclass:: mastodon.return_types.Relationship
:members:
.. autoclass:: mastodon.return_types.FilterV2
:members:
.. autoclass:: mastodon.return_types.Notification .. autoclass:: mastodon.return_types.Notification
:members: :members:
.. autoclass:: mastodon.return_types.NodeinfoUsageUsers .. autoclass:: mastodon.return_types.Context
:members: :members:
.. autoclass:: mastodon.return_types.NodeinfoUsage .. autoclass:: mastodon.return_types.UserList
:members: :members:
.. autoclass:: mastodon.return_types.NodeinfoSoftware .. autoclass:: mastodon.return_types.MediaAttachment
:members:
.. autoclass:: mastodon.return_types.NodeinfoServices
:members:
.. autoclass:: mastodon.return_types.NodeinfoMetadata
:members:
.. autoclass:: mastodon.return_types.Nodeinfo
:members:
.. autoclass:: mastodon.return_types.MediaAttachmentVideoMetadata
:members: :members:
.. autoclass:: mastodon.return_types.MediaAttachmentMetadataContainer .. autoclass:: mastodon.return_types.MediaAttachmentMetadataContainer
@ -166,188 +130,227 @@ Return types
.. autoclass:: mastodon.return_types.MediaAttachmentImageMetadata .. autoclass:: mastodon.return_types.MediaAttachmentImageMetadata
:members: :members:
.. autoclass:: mastodon.return_types.MediaAttachmentVideoMetadata
:members:
.. autoclass:: mastodon.return_types.MediaAttachmentAudioMetadata
:members:
.. autoclass:: mastodon.return_types.MediaAttachmentFocusPoint .. autoclass:: mastodon.return_types.MediaAttachmentFocusPoint
:members: :members:
.. autoclass:: mastodon.return_types.MediaAttachmentColors .. autoclass:: mastodon.return_types.MediaAttachmentColors
:members: :members:
.. autoclass:: mastodon.return_types.MediaAttachmentAudioMetadata .. autoclass:: mastodon.return_types.PreviewCard
:members: :members:
.. autoclass:: mastodon.return_types.MediaAttachment .. autoclass:: mastodon.return_types.PreviewCardAuthor
:members: :members:
.. autoclass:: mastodon.return_types.Marker .. autoclass:: mastodon.return_types.SearchV2
:members:
.. autoclass:: mastodon.return_types.InstanceVapidKey
:members:
.. autoclass:: mastodon.return_types.InstanceV2
:members:
.. autoclass:: mastodon.return_types.InstanceUsageUsers
:members:
.. autoclass:: mastodon.return_types.InstanceUsage
:members:
.. autoclass:: mastodon.return_types.InstanceURLsV2
:members:
.. autoclass:: mastodon.return_types.InstanceURLs
:members:
.. autoclass:: mastodon.return_types.InstanceTranslationConfiguration
:members:
.. autoclass:: mastodon.return_types.InstanceThumbnailVersions
:members:
.. autoclass:: mastodon.return_types.InstanceThumbnail
:members:
.. autoclass:: mastodon.return_types.InstanceStatusConfiguration
:members:
.. autoclass:: mastodon.return_types.InstanceStatistics
:members:
.. autoclass:: mastodon.return_types.InstanceRegistrations
:members:
.. autoclass:: mastodon.return_types.InstancePollConfiguration
:members:
.. autoclass:: mastodon.return_types.InstanceMediaConfiguration
:members:
.. autoclass:: mastodon.return_types.InstanceIcon
:members:
.. autoclass:: mastodon.return_types.InstanceContact
:members:
.. autoclass:: mastodon.return_types.InstanceConfigurationV2
:members:
.. autoclass:: mastodon.return_types.InstanceConfiguration
:members:
.. autoclass:: mastodon.return_types.InstanceAccountConfiguration
:members: :members:
.. autoclass:: mastodon.return_types.Instance .. autoclass:: mastodon.return_types.Instance
:members: :members:
.. autoclass:: mastodon.return_types.IdentityProof .. autoclass:: mastodon.return_types.InstanceConfiguration
:members: :members:
.. autoclass:: mastodon.return_types.FilterV2 .. autoclass:: mastodon.return_types.InstanceURLs
:members: :members:
.. autoclass:: mastodon.return_types.FilterStatus .. autoclass:: mastodon.return_types.InstanceV2
:members: :members:
.. autoclass:: mastodon.return_types.FilterResult .. autoclass:: mastodon.return_types.InstanceIcon
:members: :members:
.. autoclass:: mastodon.return_types.FilterKeyword .. autoclass:: mastodon.return_types.InstanceConfigurationV2
:members: :members:
.. autoclass:: mastodon.return_types.Filter .. autoclass:: mastodon.return_types.InstanceVapidKey
:members: :members:
.. autoclass:: mastodon.return_types.FeaturedTag .. autoclass:: mastodon.return_types.InstanceURLsV2
:members: :members:
.. autoclass:: mastodon.return_types.FamiliarFollowers .. autoclass:: mastodon.return_types.InstanceThumbnail
:members: :members:
.. autoclass:: mastodon.return_types.ExtendedDescription .. autoclass:: mastodon.return_types.InstanceThumbnailVersions
:members: :members:
.. autoclass:: mastodon.return_types.DomainBlock .. autoclass:: mastodon.return_types.InstanceStatistics
:members: :members:
.. autoclass:: mastodon.return_types.CustomEmoji .. autoclass:: mastodon.return_types.InstanceUsage
:members: :members:
.. autoclass:: mastodon.return_types.CredentialAccountSource .. autoclass:: mastodon.return_types.InstanceUsageUsers
:members: :members:
.. autoclass:: mastodon.return_types.Conversation .. autoclass:: mastodon.return_types.Rule
:members: :members:
.. autoclass:: mastodon.return_types.Context .. autoclass:: mastodon.return_types.InstanceRegistrations
:members: :members:
.. autoclass:: mastodon.return_types.Application .. autoclass:: mastodon.return_types.InstanceContact
:members: :members:
.. autoclass:: mastodon.return_types.Announcement .. autoclass:: mastodon.return_types.InstanceAccountConfiguration
:members: :members:
.. autoclass:: mastodon.return_types.AdminRetention .. autoclass:: mastodon.return_types.InstanceStatusConfiguration
:members: :members:
.. autoclass:: mastodon.return_types.AdminReport .. autoclass:: mastodon.return_types.InstanceTranslationConfiguration
:members: :members:
.. autoclass:: mastodon.return_types.AdminMeasureData .. autoclass:: mastodon.return_types.InstanceMediaConfiguration
:members: :members:
.. autoclass:: mastodon.return_types.AdminMeasure .. autoclass:: mastodon.return_types.InstancePollConfiguration
:members: :members:
.. autoclass:: mastodon.return_types.AdminIpBlock .. autoclass:: mastodon.return_types.Nodeinfo
:members: :members:
.. autoclass:: mastodon.return_types.AdminIp .. autoclass:: mastodon.return_types.NodeinfoSoftware
:members: :members:
.. autoclass:: mastodon.return_types.AdminEmailDomainBlockHistory .. autoclass:: mastodon.return_types.NodeinfoServices
:members: :members:
.. autoclass:: mastodon.return_types.AdminEmailDomainBlock .. autoclass:: mastodon.return_types.NodeinfoUsage
:members: :members:
.. autoclass:: mastodon.return_types.AdminDomainBlock .. autoclass:: mastodon.return_types.NodeinfoUsageUsers
:members: :members:
.. autoclass:: mastodon.return_types.AdminDomainAllow .. autoclass:: mastodon.return_types.NodeinfoMetadata
:members:
.. autoclass:: mastodon.return_types.AdminDimensionData
:members:
.. autoclass:: mastodon.return_types.AdminDimension
:members:
.. autoclass:: mastodon.return_types.AdminCohort
:members:
.. autoclass:: mastodon.return_types.AdminCanonicalEmailBlock
:members:
.. autoclass:: mastodon.return_types.AdminAccount
:members: :members:
.. autoclass:: mastodon.return_types.Activity .. autoclass:: mastodon.return_types.Activity
:members: :members:
.. autoclass:: mastodon.return_types.AccountField .. autoclass:: mastodon.return_types.Report
:members: :members:
.. autoclass:: mastodon.return_types.AccountCreationErrorDetailsField .. autoclass:: mastodon.return_types.AdminReport
:members: :members:
.. autoclass:: mastodon.return_types.AccountCreationErrorDetails .. autoclass:: mastodon.return_types.WebPushSubscription
:members:
.. autoclass:: mastodon.return_types.WebPushSubscriptionAlerts
:members:
.. autoclass:: mastodon.return_types.PushNotification
:members:
.. autoclass:: mastodon.return_types.Preferences
:members:
.. autoclass:: mastodon.return_types.FeaturedTag
:members:
.. autoclass:: mastodon.return_types.Marker
:members:
.. autoclass:: mastodon.return_types.Announcement
:members:
.. autoclass:: mastodon.return_types.Reaction
:members:
.. autoclass:: mastodon.return_types.StreamReaction
:members:
.. autoclass:: mastodon.return_types.FamiliarFollowers
:members:
.. autoclass:: mastodon.return_types.AdminAccount
:members:
.. autoclass:: mastodon.return_types.AdminIp
:members:
.. autoclass:: mastodon.return_types.AdminMeasure
:members:
.. autoclass:: mastodon.return_types.AdminMeasureData
:members:
.. autoclass:: mastodon.return_types.AdminDimension
:members:
.. autoclass:: mastodon.return_types.AdminDimensionData
:members:
.. autoclass:: mastodon.return_types.AdminRetention
:members:
.. autoclass:: mastodon.return_types.AdminCohort
:members:
.. autoclass:: mastodon.return_types.AdminDomainBlock
:members:
.. autoclass:: mastodon.return_types.AdminCanonicalEmailBlock
:members:
.. autoclass:: mastodon.return_types.AdminDomainAllow
:members:
.. autoclass:: mastodon.return_types.AdminEmailDomainBlock
:members:
.. autoclass:: mastodon.return_types.AdminEmailDomainBlockHistory
:members:
.. autoclass:: mastodon.return_types.AdminIpBlock
:members:
.. autoclass:: mastodon.return_types.DomainBlock
:members:
.. autoclass:: mastodon.return_types.ExtendedDescription
:members:
.. autoclass:: mastodon.return_types.FilterKeyword
:members:
.. autoclass:: mastodon.return_types.FilterStatus
:members:
.. autoclass:: mastodon.return_types.StatusSource
:members:
.. autoclass:: mastodon.return_types.Suggestion
:members:
.. autoclass:: mastodon.return_types.Translation
:members: :members:
.. autoclass:: mastodon.return_types.AccountCreationError .. autoclass:: mastodon.return_types.AccountCreationError
:members: :members:
.. autoclass:: mastodon.return_types.Account .. autoclass:: mastodon.return_types.AccountCreationErrorDetails
:members: :members:
.. autoclass:: mastodon.return_types.AccountCreationErrorDetailsField
:members:
Deprecated types
================
.. autoclass:: mastodon.return_types.Filter
:members:
.. autoclass:: mastodon.return_types.Search
:members:
.. autoclass:: mastodon.return_types.IdentityProof
:members:

899
mastodon/return_types.py
Wyświetl plik

Plik diff jest za duży Load Diff

24
srcgen/ValidateEntities.ipynb
Wyświetl plik

@ -250,11 +250,12 @@
" entity_version = \"0.0.0\"\n", " entity_version = \"0.0.0\"\n",
" all_entities_text += f\"class {entity['python_name']}(AttribAccessDict):\\n\"\n", " all_entities_text += f\"class {entity['python_name']}(AttribAccessDict):\\n\"\n",
" all_entities_text += f\" \\\"\\\"\\\"\\n {add_dot(entity['description'])}\\n\\n\"\n", " all_entities_text += f\" \\\"\\\"\\\"\\n {add_dot(entity['description'])}\\n\\n\"\n",
" all_entities_text += f\" Example:\\n\"\n", " if \"is_deprecated\" in entity and entity[\"is_deprecated\"] == True:\n",
" all_entities_text += f\" ```python\\n\"\n", " all_entities_text += f\" THIS ENTITY IS DEPRECATED. IT IS RECOMMENDED THAT YOU DO NOT USE IT.\\n\\n\"\n",
" all_entities_text += f\" # Returns a {entity['python_name']} object\\n\"\n", " all_entities_text += f\" Example:\\n\\n\"\n",
" all_entities_text += f\" {entity['func_call']}\\n\"\n", " all_entities_text += f\" .. code-block:: python\\n\\n\"\n",
" all_entities_text += f\" ```\\n\\n\"\n", " all_entities_text += f\" # Returns a {entity['python_name']} object\\n\"\n",
" all_entities_text += f\" {entity['func_call']}\\n\\n\"\n",
" all_entities_text += f\" See also (Mastodon API documentation): {entity['masto_doc_link']}\\n\"\n", " all_entities_text += f\" See also (Mastodon API documentation): {entity['masto_doc_link']}\\n\"\n",
" all_entities_text += f\" \\\"\\\"\\\"\\n\"\n", " all_entities_text += f\" \\\"\\\"\\\"\\n\"\n",
" all_entities_text += \"\\n\"\n", " all_entities_text += \"\\n\"\n",
@ -372,6 +373,19 @@
"print(\"Return types\")\n", "print(\"Return types\")\n",
"print(\"============\")\n", "print(\"============\")\n",
"for entity in entities:\n", "for entity in entities:\n",
" # Skip if deprecated\n",
" if entity.get(\"is_deprecated\") == True:\n",
" continue\n",
" print(f\".. autoclass:: mastodon.return_types.{entity['python_name']}\")\n",
" print(\" :members:\")\n",
" print(\"\")\n",
"\n",
"# Now, the deprecated entities\n",
"print(\"Deprecated types\") \n",
"print(\"================\")\n",
"for entity in entities:\n",
" if not entity.get(\"is_deprecated\") == True:\n",
" continue\n",
" print(f\".. autoclass:: mastodon.return_types.{entity['python_name']}\")\n", " print(f\".. autoclass:: mastodon.return_types.{entity['python_name']}\")\n",
" print(\" :members:\")\n", " print(\" :members:\")\n",
" print(\"\")" " print(\"\")"

3
srcgen/return_types_all_current_fixed_bu.json
Wyświetl plik

@ -8546,8 +8546,9 @@
"func_call_additional": null, "func_call_additional": null,
"func_alternate_acc": null, "func_alternate_acc": null,
"manual_update": false, "manual_update": false,
"is_deprecated": true,
"masto_doc_link": "https://docs.joinmastodon.org/entities/IdentityProof", "masto_doc_link": "https://docs.joinmastodon.org/entities/IdentityProof",
"description": "A cryptographic proof-of-identity.", "description": "A cryptographic proof-of-identity. Deprecated since 3.5.0.",
"fields": { "fields": {
"provider": { "provider": {
"description": "The name of the identity provider.", "description": "The name of the identity provider.",