Skip to content

Commit fe07190

Browse files
ItsDrikeItsDrike
committed
fixup! Restructure the project and formalize private APIs
1 parent a9e87e1 commit fe07190

File tree

5 files changed

+64
-36
lines changed

5 files changed

+64
-36
lines changed

‎docs/api/basic.rst‎

Lines changed: 42 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -44,72 +44,98 @@ These are the classes that you get back after making a request.
4444
For Java Server (1.7+)
4545
**********************
4646

47-
.. module:: mcstatus.responses
47+
.. module:: mcstatus.responses.java
4848

49-
.. autoclass:: mcstatus.responses.JavaStatusResponse()
49+
.. autoclass:: mcstatus.responses.java.JavaStatusResponse()
5050
:members:
5151
:undoc-members:
5252
:inherited-members:
5353
:exclude-members: build
5454

55-
.. autoclass:: mcstatus.responses.JavaStatusPlayers()
55+
.. autoclass:: mcstatus.responses.java.JavaStatusPlayers()
5656
:members:
5757
:undoc-members:
5858
:inherited-members:
5959
:exclude-members: build
6060

61-
.. autoclass:: mcstatus.responses.JavaStatusPlayer()
61+
.. autoclass:: mcstatus.responses.java.JavaStatusPlayer()
6262
:members:
6363
:undoc-members:
6464
:inherited-members:
6565
:exclude-members: build
6666

67-
.. autoclass:: mcstatus.responses.JavaStatusVersion()
67+
.. autoclass:: mcstatus.responses.java.JavaStatusVersion()
6868
:members:
6969
:undoc-members:
7070
:inherited-members:
7171
:exclude-members: build
7272

73-
.. autoclass:: mcstatus.responses.QueryResponse()
73+
.. module:: mcstatus.responses.query
74+
:no-index:
75+
76+
.. autoclass:: mcstatus.responses.query.QueryResponse()
7477
:members:
7578
:undoc-members:
7679
:inherited-members:
7780
:exclude-members: build
7881

79-
.. autoclass:: mcstatus.responses.QueryPlayers()
82+
.. autoclass:: mcstatus.responses.query.QueryPlayers()
8083
:members:
8184
:undoc-members:
8285
:inherited-members:
8386
:exclude-members: build
8487

85-
.. autoclass:: mcstatus.responses.QuerySoftware()
88+
.. autoclass:: mcstatus.responses.query.QuerySoftware()
8689
:members:
8790
:undoc-members:
8891
:inherited-members:
8992
:exclude-members: build
9093

94+
Forge Data
95+
**********
96+
97+
Forge mod metadata is available on :attr:`status.forge_data <mcstatus.responses.java.JavaStatusResponse.forge_data>`.
98+
99+
.. module:: mcstatus.responses.forge
100+
:no-index:
101+
102+
.. autoclass:: mcstatus.responses.forge.ForgeData()
103+
:members:
104+
:undoc-members:
105+
:inherited-members:
106+
107+
.. autoclass:: mcstatus.responses.forge.ForgeDataChannel()
108+
:members:
109+
:undoc-members:
110+
:inherited-members:
111+
112+
.. autoclass:: mcstatus.responses.forge.ForgeDataMod()
113+
:members:
114+
:undoc-members:
115+
:inherited-members:
116+
91117

92118
For Java Server (1.4-1.6)
93119
*************************
94120

95121
.. versionadded:: 12.1.0
96122

97-
.. module:: mcstatus.responses
123+
.. module:: mcstatus.responses.legacy
98124
:no-index:
99125

100-
.. autoclass:: mcstatus.responses.LegacyStatusResponse()
126+
.. autoclass:: mcstatus.responses.legacy.LegacyStatusResponse()
101127
:members:
102128
:undoc-members:
103129
:inherited-members:
104130
:exclude-members: build
105131

106-
.. autoclass:: mcstatus.responses.LegacyStatusPlayers()
132+
.. autoclass:: mcstatus.responses.legacy.LegacyStatusPlayers()
107133
:members:
108134
:undoc-members:
109135
:inherited-members:
110136
:exclude-members: build
111137

112-
.. autoclass:: mcstatus.responses.LegacyStatusVersion()
138+
.. autoclass:: mcstatus.responses.legacy.LegacyStatusVersion()
113139
:members:
114140
:undoc-members:
115141
:inherited-members:
@@ -119,22 +145,22 @@ For Java Server (1.4-1.6)
119145
For Bedrock Servers
120146
*******************
121147

122-
.. module:: mcstatus.responses
148+
.. module:: mcstatus.responses.bedrock
123149
:no-index:
124150

125-
.. autoclass:: mcstatus.responses.BedrockStatusResponse()
151+
.. autoclass:: mcstatus.responses.bedrock.BedrockStatusResponse()
126152
:members:
127153
:undoc-members:
128154
:inherited-members:
129155
:exclude-members: build
130156

131-
.. autoclass:: mcstatus.responses.BedrockStatusPlayers()
157+
.. autoclass:: mcstatus.responses.bedrock.BedrockStatusPlayers()
132158
:members:
133159
:undoc-members:
134160
:inherited-members:
135161
:exclude-members: build
136162

137-
.. autoclass:: mcstatus.responses.BedrockStatusVersion()
163+
.. autoclass:: mcstatus.responses.bedrock.BedrockStatusVersion()
138164
:members:
139165
:undoc-members:
140166
:inherited-members:

‎docs/api/internal.rst‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,32 @@ you **should not use them**, as we do not guarantee their backwards compatibilit
66
versions. They are only documented here for linkable reference to them.
77

88

9-
.. autoclass:: mcstatus.pinger.ServerPinger
9+
.. autoclass:: mcstatus._protocol.java_client.JavaClient
1010
:members:
1111
:undoc-members:
1212
:show-inheritance:
1313

14-
.. autoclass:: mcstatus.pinger.AsyncServerPinger
14+
.. autoclass:: mcstatus._protocol.java_client.AsyncJavaClient
1515
:members:
1616
:undoc-members:
1717
:show-inheritance:
1818

19-
.. autoclass:: mcstatus.legacy_status.LegacyServerStatus
19+
.. autoclass:: mcstatus._protocol.legacy_client.LegacyClient
2020
:members:
2121
:undoc-members:
2222
:show-inheritance:
2323

24-
.. autoclass:: mcstatus.legacy_status.AsyncLegacyServerStatus
24+
.. autoclass:: mcstatus._protocol.legacy_client.AsyncLegacyClient
2525
:members:
2626
:undoc-members:
2727
:show-inheritance:
2828

29-
.. autoclass:: mcstatus.bedrock_status.BedrockServerStatus
29+
.. autoclass:: mcstatus._protocol.bedrock_client.BedrockClient
3030
:members:
3131
:undoc-members:
3232
:show-inheritance:
3333

34-
.. automodule:: mcstatus.address
34+
.. automodule:: mcstatus._net.address
3535
:members:
3636
:exclude-members: Address
3737
:undoc-members:
@@ -44,32 +44,32 @@ versions. They are only documented here for linkable reference to them.
4444

4545
.. attribute:: host
4646
:type: str
47-
:canonical: mcstatus.address.Address.host
47+
:canonical: mcstatus._net.address.Address.host
4848

49-
The hostname or IP address of the server. Is a part of Public API.
49+
The hostname or IP address of the server.
5050

5151
.. attribute:: port
5252
:type: int
53-
:canonical: mcstatus.address.Address.port
53+
:canonical: mcstatus._net.address.Address.port
5454

55-
The port of the server. Is a part of Public API.
55+
The port of the server.
5656

57-
.. automodule:: mcstatus.dns
57+
.. automodule:: mcstatus._net.dns
5858
:members:
5959
:undoc-members:
6060
:show-inheritance:
6161

62-
.. autoclass:: mcstatus.responses.BaseStatusResponse
62+
.. autoclass:: mcstatus.responses.base.BaseStatusResponse
6363
:members:
6464
:undoc-members:
6565
:show-inheritance:
6666

67-
.. autoclass:: mcstatus.responses.BaseStatusPlayers
67+
.. autoclass:: mcstatus.responses.base.BaseStatusPlayers
6868
:members:
6969
:undoc-members:
7070
:show-inheritance:
7171

72-
.. autoclass:: mcstatus.responses.BaseStatusVersion
72+
.. autoclass:: mcstatus.responses.base.BaseStatusVersion
7373
:members:
7474
:undoc-members:
7575
:show-inheritance:

‎docs/examples/code/ping_as_java_and_bedrock_in_one_time.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
import asyncio
33

44
from mcstatus import BedrockServer, JavaServer
5-
from mcstatus.responses import BedrockStatusResponse, JavaStatusResponse
5+
from mcstatus.responses.bedrock import BedrockStatusResponse
6+
from mcstatus.responses.java import JavaStatusResponse
67

78

89
async def status(host: str) -> JavaStatusResponse | BedrockStatusResponse:

‎docs/examples/ping_as_java_and_bedrock_in_one_time.rst‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ You can easily ping a server as a Java server and as a Bedrock server in one tim
55

66
.. literalinclude:: code/ping_as_java_and_bedrock_in_one_time.py
77

8-
As you can see in the code, ``status`` function returns :class:`~mcstatus.responses.JavaStatusResponse`
9-
or :class:`~mcstatus.responses.BedrockStatusResponse` object. You can use
8+
As you can see in the code, ``status`` function returns
9+
:class:`~mcstatus.responses.java.JavaStatusResponse` or
10+
:class:`~mcstatus.responses.bedrock.BedrockStatusResponse` object. You can use
1011
:func:`isinstance` checks to access attributes that are only in one of the
1112
objects.
1213

‎docs/pages/faq.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,16 +48,16 @@ such error, you can re-encode text into UTF-8.
4848
>>> query.motd.to_minecraft().encode("iso-8859-1").decode("utf-8")
4949
'Привіт!'
5050
51-
:attr:`query.motd <mcstatus.querier.QueryResponse.motd>` here can be anything,
52-
that contains incorrect encoding.
51+
:attr:`query.motd <mcstatus.responses.query.QueryResponse.motd>` here can be
52+
anything, that contains incorrect encoding.
5353

5454

5555
How to get server image?
5656
------------------------
5757

5858
On Bedrock, only official servers have a server image. There is no way to get
5959
or set an icon to a custom server. For Java servers, you can use
60-
:attr:`status.icon <mcstatus.responses.JavaStatusResponse.icon>`
60+
:attr:`status.icon <mcstatus.responses.java.JavaStatusResponse.icon>`
6161
attribute. It will return `Base64 <https://en.wikipedia.org/wiki/Base64>`_
6262
encoded PNG image. If you wish to save this image into a file, this is how:
6363

0 commit comments

Comments
 (0)