File: helpers.md

package info (click to toggle)
pyvesync 3.4.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,920 kB
  • sloc: python: 16,937; makefile: 3
file content (49 lines) | stat: -rw-r--r-- 1,270 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# helpers module

The `pyvesync.utils.helpers` module contains utility functions and classes that assist with various tasks within the library. These include converting values, processing states, and managing timers. The module is designed for internal use within the library and is not intended for public use.

## Timer class

::: pyvesync.utils.helpers.Timer
    handler: python
    options:
      members:
        - update
      show_root_heading: true
      show_source: true

## Helper class

Contains common methods and attributes used by other pyvesync modules.

::: pyvesync.utils.helpers.Helpers
    handler: python
    options:
      show_root_heading: true
      show_category_heading: true
      show_root_toc_entry: true
      members_order: "source"
      inherited_members: false
      show_source: true
      filters:
      - "!Config"
      - "!^__.*"
      - "!^_.*"
      - "!req_body"

## Validators Class

Contains common method to validate numerical values.

::: pyvesync.utils.helpers.Validators
    handler: python
    options:
      show_root_heading: true
      show_category_heading: true
      show_root_toc_entry: true
      inherited_members: false
      show_source: true
      filters:
      - "!Config"
      - "!^__.*"
      - "!^_.*"