Rewrite Query response class to #306's style

docs/api/basic.rst

@@ -34,132 +34,70 @@ These are the classes that you get back after making a request.
 For Java Server
 ***************
 
-.. module:: mcstatus.status_response
+.. module:: mcstatus.responses
 
-.. autoclass:: mcstatus.status_response.JavaStatusResponse()
+.. autoclass:: mcstatus.responses.JavaStatusResponse()
     :members:
     :undoc-members:
     :inherited-members:
     :exclude-members: build
 
-.. autoclass:: mcstatus.status_response.JavaStatusPlayers()
+.. autoclass:: mcstatus.responses.JavaStatusPlayers()
     :members:
     :undoc-members:
     :inherited-members:
     :exclude-members: build
 
-.. autoclass:: mcstatus.status_response.JavaStatusPlayer()
+.. autoclass:: mcstatus.responses.JavaStatusPlayer()
     :members:
     :undoc-members:
     :inherited-members:
     :exclude-members: build
 
-.. autoclass:: mcstatus.status_response.JavaStatusVersion()
+.. autoclass:: mcstatus.responses.JavaStatusVersion()
     :members:
     :undoc-members:
     :inherited-members:
     :exclude-members: build
 
-.. module:: mcstatus.querier
-
-.. class:: QueryResponse
-    :canonical: mcstatus.querier.QueryResponse
-
-    The response object for :meth:`JavaServer.query() <mcstatus.server.JavaServer.query>`.
-
-    .. class:: Players
-        :canonical: mcstatus.querier.QueryResponse.Players
-
-        Class for storing information about players on the server.
-
-        .. attribute:: online
-            :type: int
-            :canonical: mcstatus.querier.QueryResponse.Players.online
-
-            The number of online players.
-
-        .. attribute:: max
-            :type: int
-            :canonical: mcstatus.querier.QueryResponse.Players.max
-
-            The maximum allowed number of players (server slots).
-
-        .. attribute:: names
-            :type: list[str]
-            :canonical: mcstatus.querier.QueryResponse.Players.names
-
-            The list of online players.
-
-    .. class:: Software
-        :canonical: mcstatus.querier.QueryResponse.Software
-
-        Class for storing information about software on the server.
-
-        .. attribute:: version
-            :type: str
-            :canonical: mcstatus.querier.QueryResponse.Software.version
-
-            The version of the software.
-
-        .. attribute:: brand
-            :type: str
-            :value: "vanilla"
-            :canonical: mcstatus.querier.QueryResponse.Software.brand
-
-            The brand of the software. Like `Paper <https://papermc.io>`_ or `Spigot <https://www.spigotmc.org>`_.
-
-        .. attribute:: plugins
-            :type: list[str]
-            :canonical: mcstatus.querier.QueryResponse.Software.plugins
-
-            The list of plugins. Can be empty if hidden.
-
-    .. attribute:: motd
-        :type: ~mcstatus.motd.Motd
-        :canonical: mcstatus.querier.QueryResponse.motd
-
-        The MOTD of the server. Also known as description.
-
-        .. seealso:: :doc:`/api/motd_parsing`.
-
-    .. attribute:: map
-        :type: str
-        :canonical: mcstatus.querier.QueryResponse.map
-
-        The name of the map.
-
-    .. attribute:: players
-        :type: ~QueryResponse.Players
-        :canonical: mcstatus.querier.QueryResponse.players
-
-        The players information.
+.. autoclass:: mcstatus.responses.QueryResponse()
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :exclude-members: build
 
-    .. attribute:: software
-        :type: ~QueryResponse.Software
-        :canonical: mcstatus.querier.QueryResponse.software
+.. autoclass:: mcstatus.responses.QueryPlayers()
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :exclude-members: build
 
-        The software information.
+.. autoclass:: mcstatus.responses.QuerySoftware()
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :exclude-members: build
 
 
 For Bedrock Servers
 *******************
 
-.. module:: mcstatus.status_response
+.. module:: mcstatus.responses
     :noindex:
 
-.. autoclass:: mcstatus.status_response.BedrockStatusResponse()
+.. autoclass:: mcstatus.responses.BedrockStatusResponse()
     :members:
     :undoc-members:
     :inherited-members:
     :exclude-members: build
 
-.. autoclass:: mcstatus.status_response.BedrockStatusPlayers()
+.. autoclass:: mcstatus.responses.BedrockStatusPlayers()
     :members:
     :undoc-members:
     :inherited-members:
     :exclude-members: build
 
-.. autoclass:: mcstatus.status_response.BedrockStatusVersion()
+.. autoclass:: mcstatus.responses.BedrockStatusVersion()
     :members:
     :undoc-members:
     :inherited-members:

docs/api/internal.rst

@@ -49,17 +49,17 @@ versions. They are only documented here for linkable reference to them.
    :undoc-members:
    :show-inheritance:
 
-.. autoclass:: mcstatus.status_response.BaseStatusResponse
+.. autoclass:: mcstatus.responses.BaseStatusResponse
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. autoclass:: mcstatus.status_response.BaseStatusPlayers
+.. autoclass:: mcstatus.responses.BaseStatusPlayers
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. autoclass:: mcstatus.status_response.BaseStatusVersion
+.. autoclass:: mcstatus.responses.BaseStatusVersion
     :members:
     :undoc-members:
     :show-inheritance:

docs/examples/code/ping_as_java_and_bedrock_in_one_time.py

@@ -1,7 +1,7 @@
 import asyncio
 
 from mcstatus import BedrockServer, JavaServer
-from mcstatus.status_response import BedrockStatusResponse, JavaStatusResponse
+from mcstatus.responses import BedrockStatusResponse, JavaStatusResponse
 
 
 async def status(host: str) -> JavaStatusResponse | BedrockStatusResponse:

docs/examples/code/player_list_from_query_with_fallback_on_status.py

@@ -3,8 +3,8 @@
 server = JavaServer.lookup("play.hypixel.net")
 query = server.query()
 
-if query.players.names:
-    print("Players online:", ", ".join(query.players.names))
+if query.players.list:
+    print("Players online:", ", ".join(query.players.list))
 else:
     status = server.status()
 

docs/examples/ping_as_java_and_bedrock_in_one_time.rst

@@ -5,8 +5,8 @@ You can easily ping a server as a Java server and as a Bedrock server in one tim
 
 .. literalinclude:: code/ping_as_java_and_bedrock_in_one_time.py
 
-As you can see in the code, ``status`` function returns :class:`~mcstatus.status_response.JavaStatusResponse`
-or :class:`~mcstatus.status_response.BedrockStatusResponse` object. You can use
+As you can see in the code, ``status`` function returns :class:`~mcstatus.responses.JavaStatusResponse`
+or :class:`~mcstatus.responses.BedrockStatusResponse` object. You can use
 :func:`isinstance` checks to access attributes that are only in one of the
 objects.
 

docs/pages/faq.rst

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

mcstatus/__main__.py

@@ -66,7 +66,7 @@ def query(server: JavaServer) -> None:
     print(f"software: v{response.software.version} {response.software.brand}")
     print(f"plugins: {response.software.plugins}")
     print(f'motd: "{response.motd}"')
-    print(f"players: {response.players.online}/{response.players.max} {response.players.names}")
+    print(f"players: {response.players.online}/{response.players.max} {', '.join(response.players.list)}")
 
 
 def main() -> None:

mcstatus/bedrock_status.py

@@ -8,7 +8,7 @@
 import asyncio_dgram
 
 from mcstatus.address import Address
-from mcstatus.status_response import BedrockStatusResponse
+from mcstatus.responses import BedrockStatusResponse
 
 # TODO Remove this useless __all__ after 2023-08
 __all__ = ("BedrockServerStatus", "BedrockStatusResponse")

mcstatus/motd/__init__.py

@@ -11,7 +11,7 @@
 if t.TYPE_CHECKING:
     from typing_extensions import Self
 
-    from mcstatus.status_response import RawJavaResponseMotd, RawJavaResponseMotdWhenDict  # circular import
+    from mcstatus.responses import RawJavaResponseMotd, RawJavaResponseMotdWhenDict  # circular import
 else:
     RawJavaResponseMotdWhenDict = dict
 

mcstatus/pinger.py

@@ -7,7 +7,7 @@
 
 from mcstatus.address import Address
 from mcstatus.protocol.connection import Connection, TCPAsyncSocketConnection, TCPSocketConnection
-from mcstatus.status_response import JavaStatusResponse
+from mcstatus.responses import JavaStatusResponse
 
 if TYPE_CHECKING:
     from typing_extensions import TypeAlias