calagoapi-minecraft 1.0.dev2__py3-none-any.whl → 2.0.dev1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,22 +2,24 @@
2
2
  calagoapi-minecraft: Minecraft servers for CalagoAPI.
3
3
 
4
4
  `MinecraftServer` is a `calagoapi.Server` with Minecraft features. Commands with
5
- output, console streaming, players and game/JVM metrics go through HungerBridge (the
6
- plugin/mod inside the game) using HungerBridgePy; power, resources and files stay on
7
- the panel.
5
+ output, console streaming and everything else inside the game go through HungerBridge
6
+ (the plugin/mod) using HungerBridgePy (`server.bridge`); power, resources and files stay
7
+ on the panel.
8
8
 
9
9
  from calagoapi import Panel
10
10
  from calagoapi.extensions import enable
11
11
 
12
- enable('minecraft', config={'bridge_token': 'bot:9f2c...'})
12
+ enable('minecraft', config={'bridge_token_id': 'bot', 'bridge_token_secret': '9f2c...'})
13
13
  panel = Panel(url='https://panel.example.com', api_key='...')
14
14
 
15
15
  server = panel.minecraft.getServer('abc123', bridge_url='http://10.0.0.5:1913')
16
16
  print(server.sendCommand('list'))
17
+ print(server.bridge.getTPS('1m'))
17
18
  for line in server.streamConsole(history=10, timeout=30):
18
19
  print(line)
19
20
 
20
- MinecraftServer also works without enable(): MinecraftServer(panel, 'abc123', bridge_token=...).
21
+ MinecraftServer also works without enable():
22
+ MinecraftServer(panel, 'abc123', bridge_token_id=..., bridge_token_secret=...).
21
23
  '''
22
24
  from importlib.metadata import version as _pkg_version, PackageNotFoundError
23
25
 
@@ -28,7 +30,6 @@ except PackageNotFoundError:
28
30
 
29
31
  from .exceptions import BridgeNotConfiguredError, MinecraftError # noqa: E402
30
32
  from .config import DEFAULT_CONFIG, settings # noqa: E402
31
- from .versions import PANEL_EXTENSION, VersionChangerAdmin, VersionChangerAPI, VersionManager # noqa: E402
32
33
  from .server import DEFAULT_PORT, MinecraftServer # noqa: E402
33
34
  from .manager import MinecraftManager # noqa: E402
34
35
  from .extension import MinecraftExtension # noqa: E402
@@ -40,13 +41,9 @@ __all__ = [
40
41
  'MinecraftManager',
41
42
  'MinecraftExtension',
42
43
  'AsyncMinecraftServer',
43
- 'VersionManager',
44
- 'VersionChangerAdmin',
45
- 'VersionChangerAPI',
46
44
  'MinecraftError',
47
45
  'BridgeNotConfiguredError',
48
46
  'DEFAULT_CONFIG',
49
47
  'DEFAULT_PORT',
50
- 'PANEL_EXTENSION',
51
48
  'settings',
52
49
  ]
@@ -3,7 +3,7 @@ AsyncPanel support: registers how calagoapi-minecraft objects are wrapped.
3
3
 
4
4
  async with AsyncPanel(url=..., api_key=...) as panel:
5
5
  server = await panel.minecraft.getServer('abc123')
6
- print(await server.getTPS())
6
+ print(await server.bridge.getTPS())
7
7
  async for line in server.streamConsole(history=10):
8
8
  print(line)
9
9
 
@@ -18,7 +18,6 @@ from hungerbridge import BridgeClient, Stream
18
18
  from calagoapi.aio import AsyncServer, AsyncWrapper, iterateInThread, registerAsyncType, wrap
19
19
 
20
20
  from calagoapi_minecraft.server import MinecraftServer
21
- from calagoapi_minecraft.versions import VersionChangerAdmin, VersionManager
22
21
 
23
22
 
24
23
  class AsyncMinecraftServer(AsyncServer):
@@ -26,8 +25,7 @@ class AsyncMinecraftServer(AsyncServer):
26
25
  The async version of MinecraftServer. Every method is awaitable;
27
26
  streamConsole() is an async generator over HungerBridge's log stream.
28
27
  '''
29
- async def streamConsole(self, history: int = 0, timeout: float = None, *, reconnect: bool = None,
30
- sanitize: bool = True):
28
+ async def streamConsole(self, history: int = 0, timeout: float = None, *, reconnect: bool = None):
31
29
  '''
32
30
  Yields HungerBridge console lines (see MinecraftServer.streamConsole()).
33
31
 
@@ -35,12 +33,11 @@ class AsyncMinecraftServer(AsyncServer):
35
33
  async for line in server.streamConsole(history=20):
36
34
  print(line)
37
35
  '''
38
- lines = await asyncio.to_thread(self.target.streamConsole, history, timeout, reconnect=reconnect,
39
- sanitize=sanitize)
36
+ lines = await asyncio.to_thread(self.target.streamConsole, history, timeout, reconnect=reconnect)
40
37
  async for line in iterateInThread(lines):
41
38
  yield line
42
39
 
43
- async def onConsoleLine(self, callback, history: int = 0, *, reconnect: bool = None, sanitize: bool = True):
40
+ async def onConsoleLine(self, callback, history: int = 0, *, reconnect: bool = None):
44
41
  '''
45
42
  Calls `callback(line)` for every console line; the callback may be a coroutine
46
43
  function, it then runs on this event loop. Returns the stream (`await stream.disconnect()`).
@@ -52,13 +49,10 @@ class AsyncMinecraftServer(AsyncServer):
52
49
  if inspect.isawaitable(result):
53
50
  asyncio.run_coroutine_threadsafe(result, loop)
54
51
 
55
- stream = await asyncio.to_thread(self.target.onConsoleLine, deliver, history, reconnect=reconnect,
56
- sanitize=sanitize)
52
+ stream = await asyncio.to_thread(self.target.onConsoleLine, deliver, history, reconnect=reconnect)
57
53
  return wrap(stream)
58
54
 
59
55
 
60
56
  registerAsyncType(MinecraftServer, AsyncMinecraftServer)
61
- registerAsyncType(VersionManager, AsyncWrapper)
62
- registerAsyncType(VersionChangerAdmin, AsyncWrapper)
63
57
  registerAsyncType(BridgeClient, AsyncWrapper)
64
58
  registerAsyncType(Stream, AsyncWrapper)
@@ -1,86 +1,33 @@
1
1
  '''
2
- Helpers that connect a MinecraftServer to its HungerBridge: client creation, console
3
- pickup parsing and loader/version detection for installBridge().
2
+ Helpers that connect a MinecraftServer to its HungerBridge: client creation and the
3
+ console pickup line.
4
4
 
5
- The HungerBridge protocol itself (signing, endpoints, streaming, release names) lives
6
- in HungerBridgePy (`hungerbridge`); nothing here talks HTTP to the bridge directly.
5
+ The HungerBridge protocol itself (signing, endpoints, streaming, releases) lives in
6
+ HungerBridgePy (`hungerbridge`); nothing here talks HTTP to the bridge directly.
7
7
  '''
8
8
  import re
9
9
 
10
- from hungerbridge import BridgeClient
11
- from hungerbridge.releases import loader_for
12
-
13
- from calagoapi.utils.exceptions import CalagoAPIError
10
+ from hungerbridge import BridgeClient, Credentials
14
11
 
15
12
  from calagoapi_minecraft.config import settings
16
13
 
17
14
 
18
- # "Token created. Retrieve it at: /pickup/<uuid>?passkey=<hex>" (also printed by "hb token rotate")
15
+ # The "Pickup URL" line printed by "hb token create" / "hb token rotate"
19
16
  PICKUP_PATTERN = re.compile(r'(/pickup/[0-9A-Za-z-]+\?passkey=[0-9a-fA-F]+)')
20
- ANSI_PATTERN = re.compile(r'\x1b\[[0-9;]*[A-Za-z]')
21
-
22
- # startup variables eggs commonly use for the Minecraft version
23
- VERSION_VARIABLES = ('MINECRAFT_VERSION', 'MC_VERSION', 'VERSION')
17
+ ANSI_PATTERN = re.compile(r'\x1b\[[0-9;?]*[ -/]*[@-~]')
24
18
 
25
19
 
26
- def newClient(url: str, token: str, **options) -> BridgeClient:
20
+ def newClient(url: str, credentials: Credentials, **options) -> BridgeClient:
27
21
  '''Creates a HungerBridgePy client with the configured timeout and retries; options win.'''
28
22
  config = settings()
29
23
  kwargs = {'max_retries': config['bridge_max_retries']}
30
24
  if config['bridge_timeout'] is not None:
31
25
  kwargs['timeout'] = config['bridge_timeout']
32
26
  kwargs.update(options)
33
- return BridgeClient(url, token, **kwargs)
34
-
35
-
36
- def closeClient(client) -> None:
37
- session = getattr(getattr(client, 'transport', None), 'session', None)
38
- if session is not None:
39
- session.close()
27
+ return BridgeClient(url, token_id=credentials.token_id, token_secret=credentials.token_secret, **kwargs)
40
28
 
41
29
 
42
30
  def findPickup(line: str):
43
31
  '''Returns "/pickup/<id>?passkey=<hex>" from a console line, or None.'''
44
32
  match = PICKUP_PATTERN.search(ANSI_PATTERN.sub('', line or ''))
45
33
  return match.group(1) if match else None
46
-
47
-
48
- def detectPlatform(server, loader=None, minecraft_version=None):
49
- '''
50
- Returns (loader, minecraft_version) for installBridge(). Unknown values stay None.
51
-
52
- Sources, first match wins: the arguments, the Version Changer's installed build, a
53
- reachable bridge (/server/meta), then the egg name and startup variables.
54
- '''
55
- def fill(found_loader, found_version):
56
- nonlocal loader, minecraft_version
57
- loader = loader or loader_for(found_loader)
58
- minecraft_version = minecraft_version or found_version
59
-
60
- if loader is not None:
61
- # server types such as 'PAPER' or 'PURPUR' -> 'paper'; unknown values are left for
62
- # find_release() to reject with a clear message
63
- loader = loader_for(loader) or loader
64
-
65
- if loader is None or minecraft_version is None:
66
- try:
67
- build = server.versions.getInstalledBuild() or {}
68
- fill(build.get('type'), build.get('version_id'))
69
- except CalagoAPIError:
70
- pass # Version Changer not installed on the panel
71
- if (loader is None or minecraft_version is None) and server.hasBridge():
72
- try:
73
- meta = server.bridge.getServerMeta()
74
- fill(meta.get('platform'), meta.get('minecraft_version'))
75
- except Exception:
76
- pass # bridge not running (yet)
77
- if loader is None or minecraft_version is None:
78
- egg = (server.getEggName() or '').lower()
79
- fill(next((word for word in re.split(r'[^a-z]+', egg) if loader_for(word)), None), None)
80
- if minecraft_version is None:
81
- for variable in server.getStartupVariables():
82
- value = str(variable.get('value') or '')
83
- if variable.get('env_variable') in VERSION_VARIABLES and re.fullmatch(r'\d+\.\d+(\.\d+)?', value):
84
- minecraft_version = value
85
- break
86
- return loader, minecraft_version
@@ -8,25 +8,17 @@ connectBridge()) always win.
8
8
  from types import MappingProxyType
9
9
 
10
10
  from calagoapi.extensions import ConfigurationError, ExtensionNotEnabledError
11
- from hungerbridge.auth import Credentials
11
+ from hungerbridge import Credentials
12
12
 
13
13
 
14
14
  DEFAULT_CONFIG = {
15
- # HungerBridge connection
16
- 'bridge_url': None, # None: the server's address with bridge_port
15
+ 'bridge_url': None, # None: the server's address with bridge_port
17
16
  'bridge_port': 1913,
18
- 'bridge_token': None, # 'tokenId:secret'
19
- 'bridge_timeout': None, # seconds or (connect, read); None: HungerBridgePy's default (5, 30)
20
- 'bridge_max_retries': 2, # retries after HTTP 429, inside HungerBridgePy
21
- 'stream_reconnect': True, # default for streamConsole() and onConsoleLine()
22
- # Version Changer
23
- 'auto_backup': False, # back up before server.versions.install()
24
- 'backup_name': 'Before version change',
25
- 'backup_timeout': 3600,
26
- # installBridge()
27
- 'release': 'latest',
28
- 'repository': 'HungerNet/HungerBridge',
29
- 'github_api': 'https://api.github.com',
17
+ 'bridge_token_id': None, # token for every server; per server: connectBridge()
18
+ 'bridge_token_secret': None, # its 64 hex character secret (masked in diagnostics)
19
+ 'bridge_timeout': None, # seconds or (connect, read); None: HungerBridgePy's default (5, 30)
20
+ 'bridge_max_retries': 2, # retries after HTTP 429, inside HungerBridgePy
21
+ 'stream_reconnect': True, # default for streamConsole() and onConsoleLine()
30
22
  }
31
23
 
32
24
 
@@ -47,32 +39,33 @@ def settings():
47
39
  return MappingProxyType(dict(DEFAULT_CONFIG))
48
40
 
49
41
 
50
- def checkToken(token, where: str = 'bridge_token'):
51
- '''Raises ConfigurationError unless token is None or "tokenId:secret" with a hex secret.'''
52
- if token is None:
53
- return
54
- credentials = Credentials.parse(token) if isinstance(token, str) else None
55
- if credentials is None:
56
- raise ConfigurationError(f'minecraft: {where} must look like "tokenId:secret", got a {type(token).__name__}')
42
+ def credentials(token_id, token_secret, where: str = 'bridge_token_id/bridge_token_secret'):
43
+ '''
44
+ Returns hungerbridge.Credentials for the pair, or None when both are None.
45
+
46
+ Raises:
47
+ ConfigurationError: only one of them is given, or HungerBridgePy rejects them
48
+ (empty id, secret that is not 64 hex characters). The secret is never echoed.
49
+ '''
50
+ if token_id is None and token_secret is None:
51
+ return None
52
+ if token_id is None or token_secret is None:
53
+ raise ConfigurationError(f'minecraft: {where}: give both the token id and the token secret')
57
54
  try:
58
- bytes.fromhex(credentials.secret)
59
- except ValueError:
60
- raise ConfigurationError(f'minecraft: the secret in {where} must be the 64 hex characters from the pickup') from None
55
+ return Credentials(token_id=token_id, token_secret=token_secret)
56
+ except ValueError as error:
57
+ raise ConfigurationError(f'minecraft: {where}: {error}') from None
61
58
 
62
59
 
63
60
  def validate(config: dict) -> dict:
64
- checkToken(config['bridge_token'])
61
+ credentials(config['bridge_token_id'], config['bridge_token_secret'])
65
62
  port = config['bridge_port']
66
63
  if isinstance(port, bool) or not isinstance(port, int) or not 0 < port < 65536:
67
64
  raise ConfigurationError(f'minecraft: bridge_port must be 1-65535, got {port!r}')
68
65
  if config['bridge_url'] is not None and not str(config['bridge_url']).startswith(('http://', 'https://')):
69
66
  raise ConfigurationError(f'minecraft: bridge_url must start with http:// or https://, got {config["bridge_url"]!r}')
70
- for key in ('auto_backup', 'stream_reconnect'):
71
- if not isinstance(config[key], bool):
72
- raise ConfigurationError(f'minecraft: {key} must be True or False')
73
- timeout = config['backup_timeout']
74
- if isinstance(timeout, bool) or not isinstance(timeout, (int, float)) or timeout <= 0:
75
- raise ConfigurationError('minecraft: backup_timeout must be a positive number of seconds')
67
+ if not isinstance(config['stream_reconnect'], bool):
68
+ raise ConfigurationError('minecraft: stream_reconnect must be True or False')
76
69
  retries = config['bridge_max_retries']
77
70
  if isinstance(retries, bool) or not isinstance(retries, int) or retries < 0:
78
71
  raise ConfigurationError('minecraft: bridge_max_retries must be 0 or more')
@@ -3,7 +3,7 @@ from calagoapi.utils.exceptions import CalagoAPIError
3
3
 
4
4
  class MinecraftError(CalagoAPIError):
5
5
  '''
6
- A Minecraft feature could not be used, e.g. the bridge jar for a version does not exist.
6
+ A Minecraft feature could not be used, e.g. no pickup URL appeared on the console.
7
7
 
8
8
  Errors returned by HungerBridge itself are raised unchanged as
9
9
  `hungerbridge.HungerBridgeError` subclasses (HungerBridgeAuthError, ...), and panel
@@ -17,7 +17,7 @@ class BridgeNotConfiguredError(MinecraftError):
17
17
 
18
18
  Fix it with one of:
19
19
 
20
- enable('minecraft', config={'bridge_token': 'id:secret'}) # every server
21
- server.connectBridge(url, 'id:secret') # one server
22
- server.createBridgeToken() # create one through the console
20
+ enable('minecraft', config={'bridge_token_id': 'bot', 'bridge_token_secret': '...'}) # every server
21
+ server.connectBridge(url, token_id='bot', token_secret='...') # one server
22
+ server.createBridgeToken() # create one through the console
23
23
  '''
@@ -3,7 +3,7 @@ The `minecraft` CalagoAPI extension.
3
3
 
4
4
  from calagoapi.extensions import enable
5
5
 
6
- enable('minecraft', config={'bridge_token': 'bot:9f2c...'})
6
+ enable('minecraft', config={'bridge_token_id': 'bot', 'bridge_token_secret': '9f2c...'})
7
7
  server = panel.minecraft.getServer('abc123')
8
8
 
9
9
  enable() adds `panel.minecraft` (MinecraftManager) and sets process-wide defaults for
@@ -18,34 +18,30 @@ from calagoapi_minecraft.manager import MinecraftManager
18
18
 
19
19
  class MinecraftExtension(Extension):
20
20
  '''
21
- Minecraft for CalagoAPI: MinecraftServer, the Version Changer and HungerBridge
22
- (through HungerBridgePy).
21
+ Minecraft for CalagoAPI: MinecraftServer and HungerBridge (through HungerBridgePy).
23
22
 
24
23
  Config (all optional):
25
24
  bridge_url: HungerBridge URL for every server. None uses each server's address
26
25
  with bridge_port.
27
26
  bridge_port: HungerBridge port, default 1913.
28
- bridge_token: "tokenId:secret" for every server (per server: connectBridge()).
27
+ bridge_token_id, bridge_token_secret: Token for every server (per server:
28
+ connectBridge()). Give both or neither; the secret is masked in diagnostics.
29
29
  bridge_timeout: Seconds or (connect, read); None uses HungerBridgePy's (5, 30).
30
30
  bridge_max_retries: Retries after HTTP 429, default 2.
31
31
  stream_reconnect: Default reconnect for streamConsole()/onConsoleLine(), default True.
32
- auto_backup: Back up before server.versions.install(), default False.
33
- backup_name, backup_timeout: That backup's name and how long to wait for it.
34
- release: HungerBridge release used by installBridge(), default 'latest'.
35
- repository, github_api: Where HungerBridge releases are published.
36
32
  '''
37
33
  extension_id = 'minecraft'
38
34
  metadata = ExtensionMetadata(
39
35
  author='iFamished',
40
36
  version=__version__,
41
37
  schema=1,
42
- description='Minecraft servers for CalagoAPI: HungerBridge, Version Changer, server.properties',
38
+ description='Minecraft servers for CalagoAPI: HungerBridge, server.properties, bridge installs from Modrinth',
43
39
  package='calagoapi-minecraft',
44
40
  homepage='https://github.com/HungerNet/CalagoAPI/tree/main/src/extensions/calagoapi-minecraft',
45
41
  )
46
42
  default_mode = 'direct'
47
43
  default_config = DEFAULT_CONFIG
48
- secret_config = ('bridge_token',)
44
+ secret_config = ('bridge_token_secret',)
49
45
  members = [MinecraftManager]
50
46
 
51
47
  def validateConfig(self, config):
@@ -1,56 +1,53 @@
1
- from calagoapi import Panel
2
- from calagoapi.extensions import classExtension
3
-
4
- from calagoapi_minecraft.server import MinecraftServer
5
- from calagoapi_minecraft.versions import VersionChangerAdmin
6
-
7
-
8
- @classExtension(Panel, 'minecraft')
9
- class MinecraftManager:
10
- '''
11
- Minecraft servers of a panel, available as `panel.minecraft` after `enable('minecraft')`.
12
-
13
- Example:
14
- from calagoapi.extensions import enable
15
- enable('minecraft', config={'bridge_token': 'bot:9f2c...'})
16
-
17
- server = panel.minecraft.getServer('abc123')
18
- server = panel.minecraft.getServer('abc123', bridge_url='http://10.0.0.5:1913', address='play.example.com')
19
- panel.minecraft.versionChanger.getSettings() # admin API key
20
- '''
21
- def __init__(self, panel):
22
- self.panel = panel
23
- self.versionChanger = VersionChangerAdmin(panel)
24
-
25
- def __repr__(self):
26
- return f'<MinecraftManager of {self.panel!r}>'
27
-
28
- def getServer(self, server_id: str, name: str = None, **options) -> MinecraftServer:
29
- '''
30
- Returns a server as a MinecraftServer.
31
-
32
- Args:
33
- server_id: Server UUID or short id.
34
- name: Optional display name.
35
- **options: MinecraftServer options: address, bridge_url, bridge_token.
36
- '''
37
- return self.panel.servers.getServer(server_id, name, server_class=MinecraftServer, **options)
38
-
39
- def getServers(self, search: str = None, page: int = None, per_page: int = None, all_servers: bool = False,
40
- **options):
41
- '''
42
- Returns every server the API key can see as MinecraftServer objects
43
- (the panel does not mark which servers run Minecraft; filter as you need).
44
- '''
45
- return self.panel.servers.getServers(search, page, per_page, all_servers, server_class=MinecraftServer,
46
- **options)
47
-
48
- def fromServer(self, server, **options) -> MinecraftServer:
49
- '''
50
- Turns a Server (e.g. from panel.servers.getServer()) into a MinecraftServer,
51
- reusing its fetched details.
52
-
53
- Example:
54
- server = panel.minecraft.fromServer(panel.servers.getServerByName('Survival'))
55
- '''
56
- return MinecraftServer(server.panel, server.server_id, server.name, dict(server.data), **options)
1
+ from calagoapi import Panel
2
+ from calagoapi.extensions import classExtension
3
+
4
+ from calagoapi_minecraft.server import MinecraftServer
5
+
6
+
7
+ @classExtension(Panel, 'minecraft')
8
+ class MinecraftManager:
9
+ '''
10
+ Minecraft servers of a panel, available as `panel.minecraft` after `enable('minecraft')`.
11
+
12
+ Example:
13
+ from calagoapi.extensions import enable
14
+ enable('minecraft', config={'bridge_token_id': 'bot', 'bridge_token_secret': '9f2c...'})
15
+
16
+ server = panel.minecraft.getServer('abc123')
17
+ server = panel.minecraft.getServer('abc123', bridge_url='http://10.0.0.5:1913', address='play.example.com')
18
+ '''
19
+ def __init__(self, panel):
20
+ self.panel = panel
21
+
22
+ def __repr__(self):
23
+ return f'<MinecraftManager of {self.panel!r}>'
24
+
25
+ def getServer(self, server_id: str, name: str = None, **options) -> MinecraftServer:
26
+ '''
27
+ Returns a server as a MinecraftServer.
28
+
29
+ Args:
30
+ server_id: Server UUID or short id.
31
+ name: Optional display name.
32
+ **options: MinecraftServer options: address, bridge_url, bridge_token_id, bridge_token_secret.
33
+ '''
34
+ return self.panel.servers.getServer(server_id, name, server_class=MinecraftServer, **options)
35
+
36
+ def getServers(self, search: str = None, page: int = None, per_page: int = None, all_servers: bool = False,
37
+ **options):
38
+ '''
39
+ Returns every server the API key can see as MinecraftServer objects
40
+ (the panel does not mark which servers run Minecraft; filter as you need).
41
+ '''
42
+ return self.panel.servers.getServers(search, page, per_page, all_servers, server_class=MinecraftServer,
43
+ **options)
44
+
45
+ def fromServer(self, server, **options) -> MinecraftServer:
46
+ '''
47
+ Turns a Server (e.g. from panel.servers.getServer()) into a MinecraftServer,
48
+ reusing its fetched details.
49
+
50
+ Example:
51
+ server = panel.minecraft.fromServer(panel.servers.getServerByName('Survival'))
52
+ '''
53
+ return MinecraftServer(server.panel, server.server_id, server.name, dict(server.data), **options)
@@ -1,43 +1,43 @@
1
- '''Reading and editing server.properties text, keeping comments and order.'''
2
-
3
-
4
- def formatValue(value) -> str:
5
- '''Booleans become true/false, everything else str().'''
6
- if isinstance(value, bool):
7
- return 'true' if value else 'false'
8
- return str(value)
9
-
10
-
11
- def parse(text: str) -> dict:
12
- '''
13
- Returns {key: value} for a server.properties file (values are strings).
14
-
15
- Example:
16
- parse('motd=Hello\\n# comment\\nmax-players=20') # {'motd': 'Hello', 'max-players': '20'}
17
- '''
18
- properties = {}
19
- for line in text.splitlines():
20
- line = line.strip()
21
- if not line or line.startswith(('#', '!')) or '=' not in line:
22
- continue
23
- key, value = line.split('=', 1)
24
- properties[key.strip()] = value.strip()
25
- return properties
26
-
27
-
28
- def update(text: str, values: dict) -> str:
29
- '''
30
- Returns the file text with `values` changed in place; new keys are appended.
31
-
32
- Example:
33
- update('motd=Old\\n', {'motd': 'New', 'pvp': False}) # 'motd=New\\npvp=false\\n'
34
- '''
35
- pending = {key: formatValue(value) for key, value in values.items()}
36
- lines = []
37
- for line in text.splitlines():
38
- key = line.split('=', 1)[0].strip()
39
- if '=' in line and not line.lstrip().startswith(('#', '!')) and key in pending:
40
- line = f'{key}={pending.pop(key)}'
41
- lines.append(line)
42
- lines.extend(f'{key}={value}' for key, value in pending.items())
43
- return '\n'.join(lines) + '\n'
1
+ '''Reading and editing server.properties text, keeping comments and order.'''
2
+
3
+
4
+ def formatValue(value) -> str:
5
+ '''Booleans become true/false, everything else str().'''
6
+ if isinstance(value, bool):
7
+ return 'true' if value else 'false'
8
+ return str(value)
9
+
10
+
11
+ def parse(text: str) -> dict:
12
+ '''
13
+ Returns {key: value} for a server.properties file (values are strings).
14
+
15
+ Example:
16
+ parse('motd=Hello\\n# comment\\nmax-players=20') # {'motd': 'Hello', 'max-players': '20'}
17
+ '''
18
+ properties = {}
19
+ for line in text.splitlines():
20
+ line = line.strip()
21
+ if not line or line.startswith(('#', '!')) or '=' not in line:
22
+ continue
23
+ key, value = line.split('=', 1)
24
+ properties[key.strip()] = value.strip()
25
+ return properties
26
+
27
+
28
+ def update(text: str, values: dict) -> str:
29
+ '''
30
+ Returns the file text with `values` changed in place; new keys are appended.
31
+
32
+ Example:
33
+ update('motd=Old\\n', {'motd': 'New', 'pvp': False}) # 'motd=New\\npvp=false\\n'
34
+ '''
35
+ pending = {key: formatValue(value) for key, value in values.items()}
36
+ lines = []
37
+ for line in text.splitlines():
38
+ key = line.split('=', 1)[0].strip()
39
+ if '=' in line and not line.lstrip().startswith(('#', '!')) and key in pending:
40
+ line = f'{key}={pending.pop(key)}'
41
+ lines.append(line)
42
+ lines.extend(f'{key}={value}' for key, value in pending.items())
43
+ return '\n'.join(lines) + '\n'