Source.Python/docs/_modules/__init__.html at v743 · Source-Python-Dev-Team/Source.Python

History

669 lines (528 loc) · 59 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

<!DOCTYPE html>

<head>

<title>__init__ — 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>

</ul>

</div>

<h1>Source code for __init__</h1><div class="highlight"><pre>

# ../__init__.py

"""This is the main file that loads/unloads the Python part of the plugin."""

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

# Source Python

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

# This program is free software; you can redistribute it and/or modify it

# under the terms of the GNU General Public License, version 3.0, as

# published by the Free Software Foundation.

# This program is distributed in the hope that it will be useful, but WITHOUT

# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for

# more details.

# You should have received a copy of the GNU General Public License along

# with this program. If not, see <http://www.gnu.org/licenses/>.

# As a special exception, the Source.Python Team gives you permission

# to link the code of this program (as well as its derivative works) to

# "Half-Life 2," the "Source Engine," and any Game MODs that run on software

# by the Valve Corporation. You must obey the GNU General Public License in

# all respects for all other code used. Additionally, the Source.Python

# Development Team grants this exception to all derivative works.

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

# >> FILE ACCESS LOGGER

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

# If True, all calls to open() with a path to a Source.Python data file will be

# logged in ../logs/file_access.log. The log entry will contain the file that

# is being accessed and a full stack trace. The logger will be removed as soon

# as setup_data_update() is called.

# This is a debug option to ensure that no data files are being accessed before

# the data has been updated. Release builds should have this option set to

# False.

LOG_FILE_OPERATIONS = False

if LOG_FILE_OPERATIONS:

import builtins

import traceback

from paths import SP_DATA_PATH

from paths import LOG_PATH

LOG_FILE = LOG_PATH / 'file_access.log'

# Clear log file

LOG_FILE.open('w').close()

old_open = builtins.open

def new_open(f, *args, **kwargs):

if isinstance(f, str) and f.startswith(SP_DATA_PATH):

print(f)

with LOG_FILE.open('a') as log_f:

log_f.write('File access: {}\n'.format(f))

traceback.print_stack(file=log_f)

log_f.write('\n\n')

return old_open(f, *args, **kwargs)

builtins.open = new_open

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

# >> IMPORTS

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

# Source.Python Imports

# Loggers

from loggers import _sp_logger # It's save to import this here

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

# >> LOAD & UNLOAD

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

def load():

"""Load Source.Python's Python side."""

setup_stdout_redirect()

setup_core_settings()

setup_logging()

setup_exception_hooks()

setup_data_update()

setup_translations()

setup_data()

setup_global_pointers()

setup_sp_command()

setup_auth()

setup_user_settings()

setup_entities_listener()

setup_versioning()

setup_sqlite()</div>

def unload():

"""Unload Source.Python's Python side."""

unload_plugins()

remove_entities_listener()

unload_auth()</div>

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

# >> DATA UPDATE

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

def setup_data_update():

"""Setup data update."""

_sp_logger.log_debug('Setting up data update...')

if LOG_FILE_OPERATIONS:

builtins.open = old_open

from core.settings import _core_settings

if not _core_settings.auto_data_update:

_sp_logger.log_debug('Automatic data updates are disable.')

return

_sp_logger.log_info('Checking for data updates...')

from core.update import is_new_data_available, update_data

from translations.manager import language_manager

try:

if is_new_data_available():

_sp_logger.log_info('New data is available. Downloading...')

update_data()

# languages.ini is loaded before the data has been updated. Thus,

# we need to reload the file.

language_manager.reload()

else:

_sp_logger.log_info('No new data is available.')

except:

_sp_logger.log_exception(

'An error occured during the data update.', exc_info=True)</div>

def setup_data():

"""Setup data."""

_sp_logger.log_debug('Setting up data...')

from core import GameConfigObj

from memory.manager import manager

from paths import SP_DATA_PATH

import players

players.BaseClient = manager.create_type_from_dict(

'BaseClient',

GameConfigObj(SP_DATA_PATH / 'client' / 'CBaseClient.ini'))

from core.cache import CachedProperty

from memory import get_function_info

from memory.helpers import MemberFunction

CachedProperty(

lambda self, info: MemberFunction(

manager,

info.return_type,

self.make_virtual_function(info),

self

),

doc="""Fires the given game event to this client.

:param GameEvent game_event:

The game event instance to fire.

""",

args=(get_function_info('IGameEventListener2', 'FireGameEvent'),)

).bind(players.BaseClient, 'fire_game_event')

import entities

entities._BaseEntityOutput = manager.create_type_from_dict(

'BaseEntityOutput',

GameConfigObj(SP_DATA_PATH / 'entity_output' / 'CBaseEntityOutput.ini'))

from _entities import BaseEntityOutput

try:

_fire_output = entities._BaseEntityOutput.fire_output

BaseEntityOutput.fire_output = _fire_output

except ValueError:

from warnings import warn

warn(

'Did not find address for BaseEntityOutput.fire_output. '

'OnEntityOutput listener will not fire.'

)

BaseEntityOutput.fire_output = NotImplemented

except AttributeError:

from warnings import warn

warn(

'BaseEntityOutput.fire_output not found. '

'OnEntityOutput listener will not fire.'

)

BaseEntityOutput.fire_output = NotImplemented</div>

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

# >> CORE SETTINGS

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

def setup_core_settings():

"""Setup core settings."""

_sp_logger.log_debug('Setting up core settings...')

from core.settings import _core_settings

_core_settings.load()</div>

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

# >> LOGGING

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

def setup_logging():

"""Set up logging."""

_sp_logger.log_debug('Setting up logging...')

from configobj import ConfigObjError

from cvars import ConVar

# Use try/except in case the logging values are not integers

try:

# Import the core settings dictionary

from core.settings import _core_settings

# Set the logging level

ConVar('sp_logging_level').set_int(

int(_core_settings['LOG_SETTINGS']['level']))

# Set the logging areas

ConVar('sp_logging_areas').set_int(

# Was an exception raised?

except (ValueError, ConfigObjError):

# Set the logging level to max (5)

ConVar('sp_logging_level').set_int(5)

# Set the logging area to include console, SP logs, and main log

ConVar('sp_logging_areas').set_int(7)

# Log a message about the value

_sp_logger.log_message(

'[Source.Python] Plugin did not load properly ' +

'due to the following error:')

# Re-raise the error

raise</div>

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

# >> HOOKS

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

def setup_exception_hooks():

"""Set up hooks."""

_sp_logger.log_debug('Setting up exception hooks...')

from hooks.exceptions import except_hooks

from hooks.warnings import warning_hooks</div>

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

# >> TRANSLATIONS

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

def setup_translations():

"""Set up translations."""

_sp_logger.log_debug('Setting up translations...')

# Import the Language Manager

from translations.manager import language_manager

from core.settings import _core_settings

# Set the default language

language_manager._register_default_language(

_core_settings['BASE_SETTINGS']['language'])</div>

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

# >> GLOBAL POINTERS

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

def setup_global_pointers():

"""Set up global pointers."""

_sp_logger.log_debug('Setting up global pointers...')

import sys

from warnings import warn

from core import GameConfigObj

from memory.manager import manager

from paths import SP_DATA_PATH

manager.create_global_pointers_from_file(GameConfigObj(

SP_DATA_PATH / 'memory' / 'global_pointers.ini'))

_sp_logger.log_debug('Setting up global "server" variables...')

from engines import server

try:

server.server = server.engine_server.server

except NotImplementedError:

try:

server.server = manager.get_global_pointer('Server')

except NameError:

warn(str(sys.exc_info()[1]))

_sp_logger.log_debug('Setting up global "factory_dictionary" variables...')

from entities import factories

try:

from _entities._factories import factory_dictionary

except ImportError:

try:

factory_dictionary = manager.get_global_pointer(

'EntityFactoryDictionary'

)

except NameError:

return

factories.factory_dictionary = factory_dictionary</div>

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

# >> SP COMMAND

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

def setup_sp_command():

"""Set up the 'sp' command."""

_sp_logger.log_debug('Setting up the "sp" command...')

from core.command import auth, docs, dump, plugin</div>

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

# >> AUTH

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

def setup_auth():

"""Set up authentification."""

_sp_logger.log_debug('Setting up auth...')

from auth.manager import auth_manager

auth_manager.load()</div>

def unload_auth():

"""Unload authentification."""

_sp_logger.log_debug('Unloading auth...')

from auth.manager import auth_manager

auth_manager.unload()</div>

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

# >> USER_SETTINGS

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

def setup_user_settings():

"""Set up user settings."""

_sp_logger.log_debug('Setting up user settings...')

from commands.client import client_command_manager

from commands.say import say_command_manager

from settings.menu import _player_settings

from core.settings import _core_settings

# Are there any private user settings say commands?

if _core_settings['USER_SETTINGS']['private_say_commands']:

# Register the private user settings say commands

say_command_manager.register_commands(_core_settings[

'USER_SETTINGS']['private_say_commands'].split(

','), _player_settings._private_send_menu)

# Are there any public user settings say commands?

if _core_settings['USER_SETTINGS']['public_say_commands']:

# Register the public user settings say commands

say_command_manager.register_commands(_core_settings[

'USER_SETTINGS']['public_say_commands'].split(

','), _player_settings._send_menu)

# Are there any client user settings commands?

# Register the client user settings commands

client_command_manager.register_commands(_core_settings[

'USER_SETTINGS']['client_commands'].split(

','), _player_settings._send_menu)</div>

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

# >> ENTITIES LISTENER

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

def setup_entities_listener():

"""Set up entities listener."""

_sp_logger.log_debug('Setting up entities listener...')

from warnings import warn

from _core import _sp_plugin

try:

from _entities import _global_entity_list

_global_entity_list.add_entity_listener(_sp_plugin)

except ImportError:

try:

from memory.manager import manager

manager.get_global_pointer(

'GlobalEntityList'

).add_entity_listener(_sp_plugin)

except NameError as e:

warn(e)</div>

def remove_entities_listener():

"""Remove entities listener."""

_sp_logger.log_debug('Removing entities listener...')

from _core import _sp_plugin

try:

from _entities import _global_entity_list

_global_entity_list.remove_entity_listener(_sp_plugin)

except ImportError:

try:

from memory.manager import manager

manager.get_global_pointer(

'GlobalEntityList'

).remove_entity_listener(_sp_plugin)

except NameError:

pass</div>

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

# >> PLUGINS

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

def unload_plugins():

"""Unload all plugins."""

_sp_logger.log_debug('Unloading plugins...')

from plugins.manager import plugin_manager

for plugin in plugin_manager.loaded_plugins:

plugin.unload()</div>

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

# >> VERSION

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

def setup_versioning():

"""Setup versioning."""

_sp_logger.log_debug('Setting up versioning...')

from core import version</div>

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

# >> SQLITE3

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

def setup_sqlite():

"""Pre-load libsqlite3.so.0 on Linux."""

from core import PLATFORM

if PLATFORM != 'linux':

return

_sp_logger.log_debug('Pre-loading libsqlite3.so.0...')

import ctypes

from paths import BASE_PATH

# This is required, because some systems don't have the required sqlite

# version installed. This fixes the issue by loading the library into the

# memory using its absolute path.

# Using RPATH might be a better solution, but I don't get it working...

ctypes.cdll.LoadLibrary(

BASE_PATH / 'Python3/plat-linux/libsqlite3.so.0')</div>

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

# >> STDOUT

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

def setup_stdout_redirect():

"""Setup sys.stdout redirect."""

import sys

# The idea is to always redirect sys.stdout, because this allows us to use

# print(), which will also print the output to the client console, if it

# has been triggered via RCON or on a listen server. However, the downside

# of this is that we can't flush the console anymore, which is quite

# useful in some cases (e.g. generating the wiki).

# Thus, we only redirect sys.stdout if it's None for now, which only seems

# to happen on Windows 10. Otherwise, print() wouldn't output anything.

# See also:

# https://github.com/Source-Python-Dev-Team/Source.Python/issues/151

# https://github.com/Source-Python-Dev-Team/Source.Python/issues/175

# https://github.com/Source-Python-Dev-Team/Source.Python/issues/193

if sys.stdout is not None and sys.stderr is not None:

return

_sp_logger.log_debug('Setting up sys.stdout/sys.stderr redirect...')

from core import console_message

class OutputRedirect(object):

def write(self, data):

console_message(data)

return len(data)

def flush(self):

# We can't flush anymore...

pass

if sys.stdout is None:

sys.stdout = OutputRedirect()

if sys.stderr is None:

sys.stderr = OutputRedirect()

from engines.server import engine_server

if not engine_server.is_dedicated_server():

# Return here for listen servers, because we only want to see the

# warning if reconnecting the output streams failed, which is only

# done on dedicated servers. For listen servers creating OutputRedirect

# instances is the proper fix.

return

from warnings import warn

warn(

'sys.stdout and/or sys.stderr is None. All data will be redirected through '

'core.console_message() instead. If you receive this warning, please '

'notify us and tell us your operating system, game and Source.Python '

'version. The information can be posted here: '

'https://github.com/Source-Python-Dev-Team/Source.Python/issues/175. '

'Source.Python should continue working, but we would like to figure '

'out in which situations sys.stdout is None to be able to fix this '

'issue instead of applying a workaround.')</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>

</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

__init__.html

Latest commit

History

__init__.html

File metadata and controls

init.html

init.html