Privex Python Helpers

latest

Main:

Privex Python Helpers’s documentation
Installation
- Download and install from PyPi using pip (recommended)
- (Alternative) Manual install from Git
Example Usages

Code Documentation:

AsyncIO Helpers / Wrappers
privex.helpers.black_magic
Framework-independent Cache System
Common/General Helpers
- ALPHANUM
- SAFE_CHARS
- IS_XARGS
- IS_XKWARGS
- T_PARAM
  - Methods
    - __init__
    - replace
  - Attributes
- T_PARAM_DICT
- T_PARAM_LIST
- INS_EMPTY
  - Methods
- _filter_params
- almost
- auto_list
- byteify
- call_sys
- camel_to_snake
- chunked
- construct_dict
- dec_round
- empty
- empty_if
- env_bool
- env_cast
- env_csv
- env_decimal
- env_int
- env_keyval
- extract_settings
- extract_type
- filter_form
- get_function_params
- get_return_type
- human_name
- inject_items
- io_tail
- is_false
- is_true
- parse_csv
- parse_keyval
- random_str
- reverse_io
- shell_quote
- stringify
- strip_null
- tail
- typing_to_base
- ErrHelpParser
  - Methods
    - error
- LayeredContext
  - Methods
    - __init__
    - aenter
    - aexit
    - enter
    - exit
  - Attributes
    - class_name
Collections (Data Structures + helpers)
privex.helpers.converters
Cryptography - (en/de)crypt/sign/verify
Decorators
- async_retry
- mock_decorator
- r_cache
- r_cache_async
- retry_on_err
- FO
  - Attributes
    - KWARG_ONLY
    - MIX
    - POS_AUTO
    - POS_ONLY
- FormatOpt
  - Attributes
    - KWARG_ONLY
    - MIX
    - POS_AUTO
    - POS_ONLY
Django Helpers
Exceptions (Use them in your project!)
privex.helpers.extras
- privex.helpers.extras.attrs
  - AttribDictable
    - Methods
      - __init__
      - get
- privex.helpers.extras.git
GeoIP2 (Maxmind) Wrapper Module
privex.helpers.net
privex.helpers.plugin
privex.helpers.settings
Python Packaging Helpers (setuppy)
Threading Helpers / Wrappers
privex.helpers.types
- NO_RESULT
  - Methods
- USE_ORIG_VAR
  - Methods
- IP_OR_STR
- NET_OR_STR
- IP_NET_OR_STR
- VAL_FUNC_CORO
- T
- K
- V
- C
- CL
- USE_ORIG_VAR
  - Methods
- NO_RESULT
  - Methods
- STRBYTES
- AnyNum
- Number
- NumberStr

Unit Testing

How to use the unit tests
Unit Test List / Overview

Privex Python Helpers

»
<no title> »
Threading Helpers / Wrappers »
StopperThread »
should_pause
Edit on GitHub

should_pause¶

property StopperThread.should_pause¶

Next Previous

© Copyright 2019, Privex Inc. Revision 1c976ce5.

Built with Sphinx using a theme provided by Read the Docs.

Read the Docs v: latest

Versions: latest; stable; develop

Downloads: pdf; html; epub

On Read the Docs: Project Home; Builds