diff --git a/codeql-analysis.yml b/codeql-analysis.yml new file mode 100644 index 0000000000..4607af4bf0 --- /dev/null +++ b/codeql-analysis.yml @@ -0,0 +1,71 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +on: + push: + branches: [ master, develop ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ master ] + schedule: + - cron: '41 2 * * 2' + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: [ 'javascript', 'python' ] + # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ] + # Learn more: + # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v1 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + # queries: ./path/to/local/query, your-org/your-repo/queries@main + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v1 + + # â„šī¸ Command-line programs to run using the OS shell. + # 📚 https://git.io/JvXDl + + # âœī¸ If the Autobuild fails above, remove it and uncomment the following three lines + # and modify them (or add more) to build your code if your project + # uses a compiled language + + #- run: | + # make bootstrap + # make release + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v1 diff --git a/evennia/utils/utils.py b/evennia/utils/utils.py index 3d2138872b..8e68931354 100644 --- a/evennia/utils/utils.py +++ b/evennia/utils/utils.py @@ -1036,24 +1036,18 @@ def delay(timedelay, callback, *args, **kwargs): Delay the calling of a callback (function). Args: - timedelay (int or float): The delay in seconds + timedelay (int or float): The delay in seconds. callback (callable): Will be called as `callback(*args, **kwargs)` after `timedelay` seconds. *args: Will be used as arguments to callback Keyword Args: - persistent (bool, optional): Should make the delay persistent - over a reboot or reload. Defaults to False. + persistent (bool, optional): If True the delay remains after a server restart. + persistent is False by default. any (any): Will be used as keyword arguments to callback. Returns: - deferred or int: If ``persistent`` kwarg is `False`, return deferred - that will fire with callback after `timedelay` seconds. Note that - if `timedelay()` is used in the commandhandler callback chain, the - callback chain can be defined directly in the command body and - don't need to be specified here. Reference twisted.internet.defer.Deferred. - If persistent kwarg is set, return the task's ID as an integer. This is - intended for use with ``evennia.scripts.taskhandler.TASK_HANDLER`` - `.do_task` and `.remove` methods. + task (TaskHandlerTask): An instance of a task. + Refer to, evennia.scripts.taskhandler.TaskHandlerTask Notes: The task handler (`evennia.scripts.taskhandler.TASK_HANDLER`) will @@ -1068,8 +1062,7 @@ def delay(timedelay, callback, *args, **kwargs): If persistent is set to True the delay function will return an int which is the task's id itended for use with TASK_HANDLER's do_task and remove methods. - - All task's whose time delays have passed will be called on server startup. + All persistent tasks whose time delays have passed will be called on server startup. """ global _TASK_HANDLER