Source.Python/docs/_modules/commands/typed.html at v742 · Source-Python-Dev-Team/Source.Python

History

921 lines (742 loc) · 91.3 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

<!DOCTYPE html>

<head>

<title>commands.typed — Source.Python v742 documentation</title>

</head><body>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li class="nav-item nav-item-0"><a href="../../index.html"> Source.Python v742 documentation</a> »</li>

<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li>

<li class="nav-item nav-item-this"><a href="">commands.typed</a></li>

</ul>

</div>

<h1>Source code for commands.typed</h1><div class="highlight"><pre>

# ../commands/typed.py

#: .. todo:: Add the ability to define prefixes for messages.

#: .. todo:: Add callback to the Node class. It could be called when a sub-command is required.

# =============================================================================

# >> IMPORTS

# =============================================================================

# Python Imports

# Inspect

import inspect

from inspect import Parameter

import itertools

import textwrap

# Source.Python

# Auth

from auth.manager import auth_manager

# Core

from core import AutoUnload

from core import Tokenize

# Commands

from commands import commands_logger

from commands import CommandReturn

from commands.server import server_command_manager

from commands.client import client_command_manager

from commands.say import say_command_manager

# Filters

from filters.players import parse_filter

# Messages

from messages import SayText2

from messages import TextMsg

from messages import HudDestination

# Translations

from translations.strings import TranslationStrings

# =============================================================================

# >> ALL DECLARATION

# =============================================================================

__all__ = ('PRIVATE_COMMAND_PREFIX',

'SUPPORTED_KINDS',

'ArgumentError',

'ArgumentNumberMismatch',

'CommandInfo',

'CommandNode',

'CommandParser',

'filter_str',

'InvalidArgumentValue',

'Node',

'Store',

'SubCommandError',

'SubCommandExpectedError',

'SubCommandNotFound',

'TypedClientCommand',

'TypedSayCommand',

'TypedServerCommand',

'ValidationError'

)

# =============================================================================

# >> CONSTANTS

# =============================================================================

SUPPORTED_KINDS = (

# There is no syntax for this in Python, but a PEP. If it ever gets added,

# this implementation will already support it (unless

# <Parameter object>.name is empty).

Parameter.POSITIONAL_ONLY,

Parameter.POSITIONAL_OR_KEYWORD,

Parameter.VAR_POSITIONAL,

)

PRIVATE_COMMAND_PREFIX = '/'

# =============================================================================

# >> GLOBAL VARIABLES

# =============================================================================

logger = commands_logger.typed

# =============================================================================

# >> EXCEPTIONS

# =============================================================================

class ValidationError(Exception):

def __init__(self, message='', language=None, **tokens):

self.message = message

self.language = language

self.tokens = tokens</div>

</div>

class ArgumentError(ValidationError): pass</div>

class ArgumentNumberMismatch(ArgumentError): pass</div>

class InvalidArgumentValue(ArgumentError): pass</div>

class SubCommandError(ValidationError): pass</div>

class SubCommandNotFound(SubCommandError): pass</div>

class SubCommandExpectedError(SubCommandError): pass</div>

# =============================================================================

# >> CLASSES

# =============================================================================

class Node(object):

self.description = description

self.commands = commands</div>

@property

def signature(self):

"""Return the signature of the node.

:rtype: str

"""

raise NotImplementedError('Must be implemented by a sub class.')</div>

class Store(Node, dict):

def __init__(self, commands=None, description=None):

super().__init__(commands, description)</div>

@property

def signature(self):

"""Return the signature of the node.

:rtype: str

"""

return ' '.join(self.commands) + ' <sub-command>'

@property

def help_text(self):

"""Return the help text of the node.

:rtype: str

"""

wrapper = textwrap.TextWrapper(

40, subsequent_indent=' ', break_long_words=True)

result = ''

for node in sorted(self.values(), key=lambda node: node.signature):

sig_lines = wrapper.wrap(node.signature)

desc_lines = wrapper.wrap(node.description or '')

for sig, desc in itertools.zip_longest(

sig_lines, desc_lines, fillvalue=''):

result += '\n ' + sig.ljust(40) + ' ' + desc

return result</div>

class CommandNode(Node):

def __init__(self, commands, params, callback, description, permission,

fail_callback, requires_registration):

"""Initialize the object.

.. seealso:: :meth:`CommandParser.add_command`

"""

self.params = params

self.callback = callback

# Explicitly check against True, because <permission> can also be a

# non-empty string

if permission == True:

permission = '.'.join(commands)

self.permission = permission

self.fail_callback = fail_callback

self.requires_registration = requires_registration

self.command_to_register = commands[0]</div>

@property

def signature(self):

"""Return the full signature of a command.

:rtype: str

"""

result = ' '.join(self.commands)

for param in self.params:

result += ' ' + self._param_to_str(param)

return result

@staticmethod

def _param_to_str(param):

"""Represent a parameter as a string.

:rtype: str

"""

result = '{open_char}{arg_name}{type_name}{default}{close_char}'

if (param.kind == param.VAR_POSITIONAL or

param.default is not param.empty):

open_char = '['

close_char = ']'

else:

open_char = '<'

close_char = '>'

if param.default is not param.empty:

default = '=' + str(param.default)

else:

default = ''

if param.annotation is not param.empty:

type_name = ':' + param.annotation.__name__

else:

type_name = ''

if param.kind == param.VAR_POSITIONAL:

arg_name = '*' + param.name

else:

arg_name = param.name

return result.format(open_char=open_char, arg_name=arg_name,

type_name=type_name, default=default, close_char=close_char)</div>

# TODO: This base class is not quite correct.

class CommandParser(Store):

def add_command(self, commands, params, callback, description=None,

permission=None, fail_callback=None):

"""Add a command to the parser.

:param str/list/tuple commands:

Command to register.

:param iterable params:

Parameters of the command.

:param callable callback:

The callback for the command.

:param str description:

Description of the command.

:param str permission:

Required permission to use the command.

:param callable fail_callback:

Callback that gets called if authorization failed.

:rtype: CommandNode

"""

commands = self._validate_commands(commands)

for param in params:

if param.kind not in SUPPORTED_KINDS:

raise TypeError(

'Unsupported argument type "{}" for argument.'.format(

param.kind, param.name))

command = CommandNode(tuple(commands), tuple(params), callback,

description, permission, fail_callback, commands[0] not in self)

parsed_commands = []

store = self

while commands:

command_name = commands.pop(0).lower()

parsed_commands.append(command_name)

if command_name in store:

store = store[command_name]

if (isinstance(store, CommandNode) or

(not commands and isinstance(store, Store))):

# We can't support multiple callbacks, because they might

# have different signatures.

raise ValueError('Command already exists.')

else:

if commands:

# We need to split these two lines to prevent recursive

# dicts

new_store = store[command_name] = Store(

tuple(parsed_commands))

store = new_store

else:

store[command_name] = command

return command</div>

def remove_command(self, commands):

"""Remove a command.

:param str/list/tuple:

Command to remove.

.. seealso:: :meth:`_remove_command`

.. seealso:: :meth:`_validate_commands`

"""

return self._remove_command(self._validate_commands(commands))</div>

def _remove_command(self, commands):

"""Remove a command.

:param list commands:

Command to remove.

:raise ValueError:

Raised if the node does not exist.

:return:

Return whether the base command needs to be unregistered.

:rtype: bool

"""

store = self

for command_name in commands[:-1]:

try:

store = store[command_name]

except KeyError:

raise ValueError('Command does not exist.')

del store[commands[-1]]

if len(commands) > 1:

if store:

return False

return self._remove_command(commands[:-1])

return True

def get_node(self, commands):

"""Return a node.

:param str/list/tuple:

Node to seach.

:raise ValueError:

Raised if the node does not exist.

:rtype: Node

.. seealso:: :meth:`_validate_command`

"""

store = self

for command_name in self._validate_commands(commands):

try:

store = store[command_name]

except (TypeError, KeyError):

# The TypeError happens if "store" is already a CommandNode

raise ValueError('Node does not exist.')

return store</div>

def set_node_description(self, commands, description):

"""Set the description of a node.

:param str/list/tuple:

Node to seach.

:raise ValueError:

Raised if the node does not exist.

"""

self.get_node(commands).description = description</div>

def get_command(self, commands):

"""Return a command.

:param str/list/tuple:

Command to search.

:rtype: CommandNode

.. seealso:: :meth:`get_node`

"""

command = self.get_node(commands)

assert isinstance(command, CommandNode)

return command</div>

def _validate_commands(self, commands):

"""Validate a string, list or tuple of commands.

:param str/list/tuple:

The command name or command path to validate.

:raise TypeError:

Raised if ``commands`` is not a str, list or tuple.

:raise ValueError:

Raised if ``commands`` is an empty list or tuple.

.. seealso:: :meth:`_validate_command`

"""

if isinstance(commands, str):

self._validate_command(commands)

commands = [commands]

elif not isinstance(commands, (list, tuple)):

raise TypeError('<commands> must be str, list or tuple.')

elif not commands:

raise ValueError('<commands> must not be empty.')

else:

for command_name in commands:

self._validate_command(command_name)

return list(commands)

def _validate_command(self, command_name):

"""Validate a command name.

:param str command_name:

The command name to check.

:raise ValueError:

Raised if the command name is invalid.

"""

if not command_name:

raise ValueError('Command name cannot be empty.')

if ' ' in command_name:

raise ValueError('Command cannot contain spaces.')

def clean_command(self, command, args):

"""Clean a command and its passed arguments.

:param CommandNode command:

:param iterable args:

The arguments to clean.

:rtype: list

:raise InvalidArgumentValue:

Raised if the value is invalid for an argument.

:raise ArgumentNumberMismatch:

Raised if too many/less arguments have been passed.

"""

result = []

params = list(command.params)

param = None

for arg in args:

if param is None or param.kind is not param.VAR_POSITIONAL:

try:

param = params.pop(0)

except IndexError:

raise ArgumentNumberMismatch(

'Too many arguments:\n {}'.format(command.signature))

try:

arg = param.annotation(arg)

except ValidationError:

raise

except:

raise InvalidArgumentValue(

'"{}" is an invalid value for "{}:{}".'.format(

arg, param.name, param.annotation.__name__))

result.append(arg)

for param in params:

if param.kind is param.VAR_POSITIONAL:

break

if param.default is param.empty:

raise ArgumentNumberMismatch(

'Not enough arguments:\n {}'.format(command.signature))

result.append(param.default)

return result</div>

def parse_command(self, command):

"""Parse a :class:`Command` object.

Splits the command into the actual command and its arguments.

:param Command command:

A command to parse.

:raise SubCommandNotFound:

Raised if a sub command was not found.

:raise SubCommandExpected:

Raised if a sub command was expected, but more arguments have been

passed.

:rtype: tuple

"""

args = Tokenize(command.command_string)

store = self

while args and isinstance(store, Store):

sub_command = args.pop(0).lower()

try:

store = store[sub_command]

except KeyError:

raise SubCommandNotFound(

'Sub command "{}" not found.'.format(sub_command))

if isinstance(store, Store):

raise SubCommandExpectedError(

'A sub-command is required:{}'.format(store.help_text))

return (store, args)</div>

</div>

class CommandInfo(object):

"""Stores command information for typed commands."""

def __init__(self, command, typed_command_cls, index=None, team_only=None):

"""Initializes the instance.

:param Command command:

The actual Command instance.

:param _TypedCommand typed_command_cls:

Command this instance belongs to.

:param int index:

The index of the player that issued the command. None, if it's a

server command.

:param bool team_only:

Indicates whether the command was issued in team chat. None, if

it's a server or client command.

"""

self.command = command

self.typed_command_cls = typed_command_cls

self.index = index

self.team_only = team_only</div>

def reply(self, msg, language=None, **tokens):

"""Reply to the command issuer.

:param str/TranslationStrings msg:

Message to send.

:param str language:

Language to be used.

:param tokens:

Translation tokens for message.

"""

self.typed_command_cls.send_message(self, msg, language, **tokens)</div>

def is_private_command(self):

"""Return ``True`` if it's a private command.

:rtype: bool

"""

return self.command[0].startswith(PRIVATE_COMMAND_PREFIX)</div>

@property

def auto_command_return(self):

"""Determine the probably most desired ``CommandReturn`` value.

For server commands it will always return ``CommandReturn.CONTINUE``.

Client commands will always use ``CommandReturn.BLOCK``. For say

commands it's determined by checking the prefix. If the command starts

with a slash (``/``) it's handled as a private command. Thus,

``CommandReturn.BLOCK`` is returned. Otherwise

``CommandReturn.CONTINUE`` is used.

:rtype: CommandReturn

"""

return self.typed_command_cls.get_auto_command_return(self)</div>

# We can't integrate this into SayCommand, ServerCommand and ClientCommand,

# because multiple callbacks are not supported by this system (because of the

# possibility of different function signatures). But multiple callbacks are

# important e.g. for ClientCommand, because that can actually hook client

# commands and multiple plugins might want to hook a client command.

class _TypedCommand(AutoUnload):

"""Decorator class to create typed commands."""

def __init__(self, commands, permission=None, fail_callback=None):

"""Register a typed command callback.

:param str/list/tuple commands:

(Sub-) command to register.

:param str/bool permission:

A permission that is required to execute the command. If True, the

permission string will be generated from the given command.

:param callable fail_callback:

Called when the executer does not have the required permission.

"""

self.commands = commands

self.permission = permission

self.fail_callback = fail_callback

self.command = None

def __call__(self, callback):

"""Finish registering a typed command callback.

:param callable callback:

A callback that get called when the command has been issued.

:raise ValueError:

Raised if the callback does not accept at least one argument

(command info).

:return:

Return the passed callback.

:rtype: callable

"""

params = tuple(inspect.signature(callback).parameters.values())

if not params:

raise ValueError(

'Callback must at least accept 1 argument (command_info).')

self.command = self.parser.add_command(

self.commands, params[1:], callback, inspect.getdoc(callback),

self.permission, self.fail_callback)

if self.command.requires_registration:

self.manager.register_commands(

self.command.command_to_register, self.on_command)

return callback

def _unload_instance(self):

try:

if self.parser.remove_command(self.commands):

self.manager.unregister_commands(

except ValueError:

pass

@classmethod

def on_command(cls, command, *args):

"""Called when a (base) command has been executed.

Parse the command, clean its arguments and execute the callback.

"""

info = CommandInfo(command, cls, *args)

try:

command_node, args = cls.parser.parse_command(info.command)

result = cls.on_clean_command(info, command_node, args)

except ValidationError as e:

info.reply(e.message, e.language, **e.tokens)

else:

if result is None:

return info.auto_command_return

return result

return CommandReturn.CONTINUE

@classmethod

def on_clean_command(cls, command_info, command_node, args):

"""Called when the arguments of the parsed command should be cleaned.

:rtype: CommandReturn

"""

cleaned_args = cls.parser.clean_command(command_node, args)

return command_node.callback(command_info, *cleaned_args)

@property

def parser(self):

"""Return the parser to use.

:rtype: CommandParser

"""

raise NotImplementedError('Needs to be implemented by a sub class.')

@property

def manager(self):

"""Return the manager that registers the commands.

:rtype: _BaseCommandManager

"""

raise NotImplementedError('Needs to be implemented by a sub class.')

@staticmethod

def send_message(command_info, message, language=None, **tokens):

"""Send a message."""

raise NotImplementedError('Needs to be implemented by a sub class.')

@classmethod

def get_auto_command_return(cls, info):

"""Return the most desired ``CommandReturn`` value.

:rtype: CommandReturn

"""

raise NotImplementedError('Needs to be implemented by a sub class.')

class TypedServerCommand(_TypedCommand):

"""Decorator class to create typed server commands."""

parser = CommandParser()

manager = server_command_manager

@staticmethod

# Translate the message if it's a :class:`TranslationStrings` object.

if isinstance(message, TranslationStrings):

message = message.get_string(language, **tokens)

logger.log_message(message)</div>

@classmethod

return CommandReturn.CONTINUE</div>

</div>

class _TypedPlayerCommand(_TypedCommand):

"""Decorator class to create typed player based commands."""

@classmethod

if (command_node.permission is None or

auth_manager.is_player_authorized(

command_info.index, command_node.permission)):

return super().on_clean_command(command_info, command_node, args)

return cls.handle_fail_callback(command_info, command_node, args)

@classmethod

def handle_fail_callback(cls, command_info, command_node, args):

if command_node.fail_callback is not None:

return command_node.fail_callback(command_info, args)

# TODO: Send "Required permission: <permission>" or write it to the

# logs?

cls.send_message(

command_info,

'You are not authorized to use this command.\n' +

'Required permission: {}'.format(command_node.permission))

return CommandReturn.CONTINUE

class TypedClientCommand(_TypedPlayerCommand):

"""Decorator class to create typed client commands."""

parser = CommandParser()

manager = client_command_manager

@staticmethod

TextMsg(message, HudDestination.CONSOLE).send(command_info.index, **tokens)</div>

@classmethod

return CommandReturn.BLOCK</div>

</div>

class TypedSayCommand(_TypedPlayerCommand):

"""Decorator class to create typed say commands."""

parser = CommandParser()

manager = say_command_manager

@staticmethod

SayText2(message).send(command_info.index, **tokens)</div>

@classmethod

if info.is_private_command():

return CommandReturn.BLOCK

return CommandReturn.CONTINUE</div>

</div>

# =============================================================================

# >> COMMAND ANNOTATIONS

# =============================================================================

def filter_str(expr):

""".. seealso:: :func:`filters.players.parse_filter`"""

# A simple wrapper for parse_filter for a better looking command signature

return parse_filter(expr)</div>

</pre></div>

</div>

</a>

<h3 id="searchlabel">Quick search</h3>

</form>

</div>

</search>

</div>

</div>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

>index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li class="nav-item nav-item-0"><a href="../../index.html"> Source.Python v742 documentation</a> »</li>

<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>

<li class="nav-item nav-item-this"><a href="">commands.typed</a></li>

</ul>

</div>

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.

</div>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

typed.html

Latest commit

History

typed.html

File metadata and controls