Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

43 lines (31 loc) · 1.28 KB

Contributing to ClyphX

Gotchas

  • Live API objects must not be checked using is None since this would treat lost weakrefs as valid.
    # True both if obj represents a lost weakref or is None
    obj == None
    
  • Lists and dicts should be created with list() and dict(), as oppossed to [] and {}, to make use of the future lib optimizations.

Vendored packages

package version description
python-future 0.18.2 Compability layer between Python 2.7 and Python 3
typing 3.7.4.3 Backport of the typing built-in module for Python 2.7
retoken - Regex lexer

VSCode

Rename .vscode/.settings.jsonc to .vscode/settings.json.

VSCode Tasks

Shift+Ctrl+PTasks: Run tasks

task description
(re)start Live Restart Live, or start it if closed.
open Log.txt Open Live's Log.txt with the system default application for txt files.

Testing

pytest tests/<file>::test