8 Commits

Author SHA1 Message Date
ac5b117e2c bump aio-q3-rcon dep version
patch bump
2026-03-23 12:16:35 +00:00
4f5272ac32 patch bump 2026-03-22 10:35:41 +00:00
04c4e40063 rescale the boxed outputs 2026-03-22 10:35:23 +00:00
2233f5eda1 use workspace to add path dep 2026-03-22 05:29:40 +00:00
12bcaca00c patch bump 2026-03-22 04:11:15 +00:00
bfb45efb32 updates to the Console classes:
- added ErrConsole
- import console as namespace throughout the package
- swap out the static methods for instance methods.

Wrap the entry point in try/except.
Note, catching IncorrectPasswordError is currently not working. See https://github.com/Iapetus-11/aio-q3-rcon/issues/4
2026-03-22 04:10:53 +00:00
9a4fefcbbb add aio-q3-rcon as local path dependency 2026-03-22 03:05:47 +00:00
e2fb241bc2 upd pre-commit config 2026-03-21 14:19:11 +00:00
15 changed files with 90 additions and 60 deletions

2
.gitignore vendored
View File

@@ -210,3 +210,5 @@ marimo/_lsp/
__marimo__/ __marimo__/
# End of ignr # End of ignr
test-*.py

View File

@@ -1,4 +1,11 @@
repos: repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v2.3.0
hooks:
- id: check-yaml
- id: end-of-file-fixer
- id: trailing-whitespace
- repo: local - repo: local
hooks: hooks:
- id: update-readme - id: update-readme

View File

@@ -20,7 +20,7 @@ classifiers = [
"Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy", "Programming Language :: Python :: Implementation :: PyPy",
] ]
dependencies = ["aio-q3-rcon>=1.0.0", "clypi>=1.8.2"] dependencies = ["aio-q3-rcon>=1.0.1", "clypi>=1.8.2"]
[project.scripts] [project.scripts]
q3rcon-cli = "q3rcon_cli.cli:main" q3rcon-cli = "q3rcon_cli.cli:main"
@@ -33,6 +33,9 @@ Source = "https://github.com/onyx-and-iris/q3rcon-cli"
[tool.hatch.version] [tool.hatch.version]
path = "src/q3rcon_cli/__about__.py" path = "src/q3rcon_cli/__about__.py"
[tool.hatch.envs.default]
workspace.members = [{ path = "../aio-q3-rcon" }]
[tool.hatch.envs.types] [tool.hatch.envs.types]
extra-dependencies = ["mypy>=1.0.0"] extra-dependencies = ["mypy>=1.0.0"]
[tool.hatch.envs.types.scripts] [tool.hatch.envs.types.scripts]

View File

@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2026-present onyx-and-iris <code@onyxandiris.online> # SPDX-FileCopyrightText: 2026-present onyx-and-iris <code@onyxandiris.online>
# #
# SPDX-License-Identifier: MIT # SPDX-License-Identifier: MIT
__version__ = '0.2.0' __version__ = '0.2.3'

View File

@@ -1,8 +1,9 @@
import clypi import clypi
from aioq3rcon import Client from aioq3rcon import Client, IncorrectPasswordError
from clypi import Command, arg from clypi import Command, arg
from typing_extensions import override from typing_extensions import override
from . import console
from .commands import ( from .commands import (
Fastrestart, Fastrestart,
Gametype, Gametype,
@@ -14,7 +15,6 @@ from .commands import (
Plugins, Plugins,
Status, Status,
) )
from .console import Console
Subcommands = ( Subcommands = (
Fastrestart Fastrestart
@@ -96,16 +96,20 @@ class Q3rconCli(Command):
) as client: ) as client:
try: try:
if response := await client.send_command(command): if response := await client.send_command(command):
Console.print_response(response) console.out.print_response(response)
except TimeoutError: except TimeoutError:
print( console.err.print(
clypi.style( f"Timeout waiting for response for command: '{command}'"
'Timeout waiting for response for command:', fg='red'
),
clypi.style(command, fg='yellow'),
) )
def main(): def main():
cli = Q3rconCli().parse() try:
cli.start() cli = Q3rconCli().parse()
cli.start()
except IncorrectPasswordError:
console.err.print('Incorrect password provided.')
except TimeoutError:
console.err.print(
f"Timeout waiting for response for command: '{type(cli.subcommand).__name__.lower()}'"
)

View File

@@ -2,7 +2,7 @@ from aioq3rcon import Client
from clypi import Command, arg from clypi import Command, arg
from typing_extensions import override from typing_extensions import override
from q3rcon_cli.console import Console from q3rcon_cli import console
class Fastrestart(Command): class Fastrestart(Command):
@@ -16,4 +16,4 @@ class Fastrestart(Command):
async def run(self): async def run(self):
async with Client(self.host, self.port, self.password) as client: async with Client(self.host, self.port, self.password) as client:
if response := await client.send_command('fast_restart'): if response := await client.send_command('fast_restart'):
Console.print_response(response) console.out.print_response(response)

View File

@@ -2,7 +2,7 @@ from aioq3rcon import Client
from clypi import Command, Positional, Spinner, arg from clypi import Command, Positional, Spinner, arg
from typing_extensions import override from typing_extensions import override
from q3rcon_cli.console import Console from q3rcon_cli import console
class Gametype(Command): class Gametype(Command):
@@ -26,7 +26,7 @@ class Gametype(Command):
if not Gametype.new_gametype: if not Gametype.new_gametype:
async with Client(self.host, self.port, self.password) as client: async with Client(self.host, self.port, self.password) as client:
if response := await client.send_command('g_gametype'): if response := await client.send_command('g_gametype'):
Console.print_cvar(response) console.out.print_cvar(response)
return return
async with Client(self.host, self.port, self.password) as client: async with Client(self.host, self.port, self.password) as client:
@@ -40,4 +40,4 @@ class Gametype(Command):
client.fragment_read_timeout = DEFAULT_FRAGMENT_READ_TIMEOUT client.fragment_read_timeout = DEFAULT_FRAGMENT_READ_TIMEOUT
if response := await client.send_command('g_gametype'): if response := await client.send_command('g_gametype'):
Console.print_cvar(response) console.out.print_cvar(response)

View File

@@ -2,7 +2,7 @@ from aioq3rcon import Client
from clypi import Command, Positional, arg from clypi import Command, Positional, arg
from typing_extensions import override from typing_extensions import override
from q3rcon_cli.console import Console from q3rcon_cli import console
class Hostname(Command): class Hostname(Command):
@@ -21,10 +21,10 @@ class Hostname(Command):
if not self.new_hostname: if not self.new_hostname:
async with Client(self.host, self.port, self.password) as client: async with Client(self.host, self.port, self.password) as client:
if response := await client.send_command('sv_hostname'): if response := await client.send_command('sv_hostname'):
Console.print_cvar(response) console.out.print_cvar(response)
return return
async with Client(self.host, self.port, self.password) as client: async with Client(self.host, self.port, self.password) as client:
await client.send_command(f'sv_hostname {self.new_hostname}') await client.send_command(f'sv_hostname {self.new_hostname}')
if response := await client.send_command('sv_hostname'): if response := await client.send_command('sv_hostname'):
Console.print_cvar(response) console.out.print_cvar(response)

View File

@@ -2,7 +2,7 @@ from aioq3rcon import Client
from clypi import Command, Positional, Spinner, arg from clypi import Command, Positional, Spinner, arg
from typing_extensions import override from typing_extensions import override
from q3rcon_cli.console import Console from q3rcon_cli import console
class Map(Command): class Map(Command):
@@ -21,7 +21,7 @@ class Map(Command):
if not self.new_map: if not self.new_map:
async with Client(self.host, self.port, self.password) as client: async with Client(self.host, self.port, self.password) as client:
if response := await client.send_command('mapname'): if response := await client.send_command('mapname'):
Console.print_cvar(response) console.out.print_cvar(response)
return return
async with Spinner('Changing map...'): async with Spinner('Changing map...'):
@@ -30,4 +30,4 @@ class Map(Command):
) as client: ) as client:
await client.send_command(f'map mp_{self.new_map.removeprefix("mp_")}') await client.send_command(f'map mp_{self.new_map.removeprefix("mp_")}')
if response := await client.send_command('mapname'): if response := await client.send_command('mapname'):
Console.print_cvar(response) console.out.print_cvar(response)

View File

@@ -2,7 +2,7 @@ from aioq3rcon import Client
from clypi import Command, arg from clypi import Command, arg
from typing_extensions import override from typing_extensions import override
from q3rcon_cli.console import Console from q3rcon_cli import console
class Mapname(Command): class Mapname(Command):
@@ -16,4 +16,4 @@ class Mapname(Command):
async def run(self): async def run(self):
async with Client(self.host, self.port, self.password) as client: async with Client(self.host, self.port, self.password) as client:
if response := await client.send_command('mapname'): if response := await client.send_command('mapname'):
Console.print_cvar(response) console.out.print_cvar(response)

View File

@@ -2,7 +2,7 @@ from aioq3rcon import Client
from clypi import Command, Spinner, arg from clypi import Command, Spinner, arg
from typing_extensions import override from typing_extensions import override
from q3rcon_cli.console import Console from q3rcon_cli import console
class Maprestart(Command): class Maprestart(Command):
@@ -19,4 +19,4 @@ class Maprestart(Command):
self.host, self.port, self.password, fragment_read_timeout=1 self.host, self.port, self.password, fragment_read_timeout=1
) as client: ) as client:
if response := await client.send_command('map_restart'): if response := await client.send_command('map_restart'):
Console.print_response(response) console.out.print_response(response)

View File

@@ -2,7 +2,7 @@ from aioq3rcon import Client
from clypi import Command, Spinner, arg from clypi import Command, Spinner, arg
from typing_extensions import override from typing_extensions import override
from q3rcon_cli.console import Console from q3rcon_cli import console
class Maprotate(Command): class Maprotate(Command):
@@ -19,4 +19,4 @@ class Maprotate(Command):
self.host, self.port, self.password, fragment_read_timeout=1 self.host, self.port, self.password, fragment_read_timeout=1
) as client: ) as client:
if response := await client.send_command('map_rotate'): if response := await client.send_command('map_rotate'):
Console.print_response(response) console.out.print_response(response)

View File

@@ -2,7 +2,7 @@ from aioq3rcon import Client
from clypi import Command, arg from clypi import Command, arg
from typing_extensions import override from typing_extensions import override
from q3rcon_cli.console import Console from q3rcon_cli import console
class Plugins(Command): class Plugins(Command):
@@ -16,4 +16,4 @@ class Plugins(Command):
async def run(self): async def run(self):
async with Client(self.host, self.port, self.password) as client: async with Client(self.host, self.port, self.password) as client:
if response := await client.send_command('plugins'): if response := await client.send_command('plugins'):
Console.print_response(response) console.out.print_response(response)

View File

@@ -2,7 +2,7 @@ from aioq3rcon import Client
from clypi import Command, Spinner, arg from clypi import Command, Spinner, arg
from typing_extensions import override from typing_extensions import override
from q3rcon_cli.console import Console from q3rcon_cli import console
class Status(Command): class Status(Command):
@@ -19,4 +19,4 @@ class Status(Command):
self.host, self.port, self.password, fragment_read_timeout=0.5 self.host, self.port, self.password, fragment_read_timeout=0.5
) as client: ) as client:
if response := await client.send_command('status'): if response := await client.send_command('status'):
Console.print_status(response) console.out.print_status(response)

View File

@@ -5,6 +5,19 @@ from clypi import cprint
class Console: class Console:
def __init__(self, style: str = 'yellow'):
self.style = style
def print(self, message: str, style: str | None = None):
cprint(message, fg=style or self.style)
class ErrorConsole(Console):
def __init__(self):
super().__init__(style='red')
class OutConsole(Console):
COLOUR_CODE_REGEX = re.compile(r'\^[0-9]') COLOUR_CODE_REGEX = re.compile(r'\^[0-9]')
STATUS_PLAYER_REGEX = re.compile( STATUS_PLAYER_REGEX = re.compile(
r'^\s*(?P<slot>[0-9]+)\s+' r'^\s*(?P<slot>[0-9]+)\s+'
@@ -30,18 +43,16 @@ class Console:
) )
@staticmethod @staticmethod
def remove_colour_codes(s: str) -> str: def _remove_colour_codes(s: str) -> str:
"""Remove Quake 3 colour codes from a string.""" """Remove Quake 3 colour codes from a string."""
return Console.COLOUR_CODE_REGEX.sub('', s) return OutConsole.COLOUR_CODE_REGEX.sub('', s)
@staticmethod def print_response(self, response: str):
def print_response(response: str): response = self._remove_colour_codes(response).removeprefix('print\n')
response = Console.remove_colour_codes(response).removeprefix('print\n')
cprint(f'\n{response}\n', fg='yellow') cprint(f'\n{response}\n', fg=self.style)
@staticmethod def print_status(self, response: str):
def print_status(response: str):
_slots = [] _slots = []
_scores = [] _scores = []
_pings = [] _pings = []
@@ -51,45 +62,48 @@ class Console:
lines = response.splitlines() lines = response.splitlines()
for line in lines: for line in lines:
if m := Console.STATUS_PLAYER_REGEX.match(line): if m := OutConsole.STATUS_PLAYER_REGEX.match(line):
_slots.append(m.group('slot')) _slots.append(m.group('slot'))
_scores.append(m.group('score')) _scores.append(m.group('score'))
_pings.append(m.group('ping')) _pings.append(m.group('ping'))
_guids.append(m.group('guid')) _guids.append(m.group('guid'))
_names.append(m.group('name')) _names.append(self._remove_colour_codes(m.group('name')))
_ips.append(m.group('ip')) _ips.append(m.group('ip'))
if not _slots: if not _slots:
cprint('\nNo players connected.\n', fg='yellow') cprint('\nNo players connected.\n', fg=self.style)
return return
slots = clypi.boxed(_slots, title='Slot', width=15) slots = clypi.boxed(_slots, title='Slot', width=10, align='center')
scores = clypi.boxed(_scores, title='Score', width=15) scores = clypi.boxed(_scores, title='Score', width=10, align='center')
pings = clypi.boxed(_pings, title='Ping', width=15) pings = clypi.boxed(_pings, title='Ping', width=10, align='center')
guids = clypi.boxed(_guids, title='GUID', width=40) guids = clypi.boxed(_guids, title='GUID', width=len(max(_guids, key=len)) + 4)
names = clypi.boxed(_names, title='Name', width=30) names = clypi.boxed(_names, title='Name', width=len(max(_names, key=len)) + 4)
ips = clypi.boxed(_ips, title='IP', width=30) ips = clypi.boxed(_ips, title='IP', width=len(max(_ips, key=len)) + 4)
print(f'\n{clypi.stack(slots, scores, pings, guids, names, ips, padding=0)}') print(f'\n{clypi.stack(slots, scores, pings, guids, names, ips, padding=0)}')
@staticmethod def print_cvar(self, response: str):
def print_cvar(response: str): response = self._remove_colour_codes(response).removeprefix('print\n')
response = Console.remove_colour_codes(response).removeprefix('print\n')
if m := Console.CVAR_REGEX.match(response): if m := self.CVAR_REGEX.match(response):
name = clypi.boxed( name = clypi.boxed(
[m.group('name')], title='Name', width=max(len(m.group('name')) + 4, 30) [m.group('name')], title='Name', width=max(len(m.group('name')) + 4, 15)
) )
value = clypi.boxed( value = clypi.boxed(
[m.group('value')], [m.group('value')],
title='Value', title='Value',
width=max(len(m.group('value')) + 4, 30), width=max(len(m.group('value')) + 4, 15),
) )
default = clypi.boxed( default = clypi.boxed(
[m.group('default')], [m.group('default')],
title='Default', title='Default',
width=max(len(m.group('default')) + 4, 30), width=max(len(m.group('default')) + 4, 15),
) )
info = clypi.boxed( info = clypi.boxed(
[m.group('info')], title='Info', width=max(len(m.group('info')) + 4, 30) [m.group('info')], title='Info', width=max(len(m.group('info')) + 4, 15)
) )
print(f'\n{clypi.stack(name, value, default, info, padding=0)}') print(f'\n{clypi.stack(name, value, default, info, padding=0)}')
out = OutConsole()
err = ErrorConsole()