Enum

`pycodecov.enums`

Module to store common enum classes used by pycodecov.

`CommitState`

Bases: StrEnum

A str enum class that define valid commit state.

Attributes:

Name	Type	Description
`COMPLETE`	`str`	`"complete"`
`PENDING`	`str`	`"pending"`
`ERROR`	`str`	`"error"`
`SKIPPED`	`str`	`"skipped"`

Examples:

>>> CommitState("complete")
<CommitState.COMPLETE: 'complete'>
>>> CommitState["COMPLETE"]
<CommitState.COMPLETE: 'complete'>
>>> CommitState.COMPLETE
<CommitState.COMPLETE: 'complete'>
>>> CommitState.COMPLETE == "complete"
True
>>> print(CommitState.COMPLETE)
complete

`Coverage`

Bases: IntEnum

An int enum class that define valid coverage status.

Attributes:

Name	Type	Description
`HIT`	`int`	`0`
`MISS`	`int`	`1`
`PARTIAL`	`int`	`2`

Examples:

>>> Coverage(0)
<Coverage.HIT: 0>
>>> Coverage["HIT"]
<Coverage.HIT: 0>
>>> Coverage.HIT
<Coverage.HIT: 0>
>>> Coverage.HIT == 0
True
>>> print(Coverage.HIT)
0

`Interval`

Bases: StrEnum

A str enum class that define valid interval.

Attributes:

Name	Type	Description
`ONE_DAY`	`str`	`"1d"`, one day
`ONE_WEEK`	`str`	`"7d"`, one week
`ONE_MONTH`	`str`	`"30d"`, one month

Examples:

>>> Interval("1d")
<Interval.ONE_DAY: '1d'>
>>> Interval["ONE_DAY"]
<Interval.ONE_DAY: '1d'>
>>> Interval.ONE_DAY
<Interval.ONE_DAY: '1d'>
>>> Interval.ONE_DAY == "1d"
True
>>> print(Interval.ONE_DAY)
1d

`Language`

Bases: StrEnum

A str enum class that define valid programming languages.

Attributes:

Name	Type	Description
`JAVASCRIPT`	`str`	`"javascript"`
`SHELL`	`str`	`"shell"`
`PYTHON`	`str`	`"python"`
`RUBY`	`str`	`"ruby"`
`PERL`	`str`	`"perl"`
`DART`	`str`	`"dart"`
`JAVA`	`str`	`"java"`
`C`	`str`	`"c"`
`CLOJURE`	`str`	`"clojure"`
`D`	`str`	`"d"`
`FORTRAN`	`str`	`"fortran"`
`GO`	`str`	`"go"`
`GROOVY`	`str`	`"groovy"`
`KOTLIN`	`str`	`"kotlin"`
`PHP`	`str`	`"php"`
`R`	`str`	`"r"`
`SCALA`	`str`	`"scala"`
`SWIFT`	`str`	`"swift"`
`OBJECTIVE_C`	`str`	`"objective-c"`
`XTEND`	`str`	`"xtend"`
`TYPESCRIPT`	`str`	`"typescript"`
`HASKELL`	`str`	`"haskell"`
`RUST`	`str`	`"rust"`
`LUA`	`str`	`"lua"`
`MATLAB`	`str`	`"matlab"`
`ASSEMBLY`	`str`	`"assembly"`
`SCHEME`	`str`	`"scheme"`
`POWERSHELL`	`str`	`"powershell"`
`APEX`	`str`	`"apex"`
`VERILOG`	`str`	`"verilog"`
`COMMON_LISP`	`str`	`"common lisp"`
`ERLANG`	`str`	`"erlang"`
`JULIA`	`str`	`"julia"`
`PROLOG`	`str`	`"prolog"`
`VUE`	`str`	`"vue"`
`CPP`	`str`	`"c++"`
`C_SHARP`	`str`	`"c#"`
`F_SHARP`	`str`	`"f#"`

Examples:

>>> Language("javascript")
<Language.JAVASCRIPT: 'javascript'>
>>> Language["JAVASCRIPT"]
<Language.JAVASCRIPT: 'javascript'>
>>> Language.JAVASCRIPT
<Language.JAVASCRIPT: 'javascript'>
>>> Language.JAVASCRIPT == "javascript"
True
>>> print(Language.JAVASCRIPT)
javascript

`PullState`

Bases: StrEnum

A str enum class that define valid pull state.

Attributes:

Name	Type	Description
`OPEN`	`str`	`"open"`
`MERGED`	`str`	`"merged"`
`CLOSED`	`str`	`"closed"`

Examples:

>>> PullState("open")
<PullState.OPEN: 'open'>
>>> PullState["OPEN"]
<PullState.OPEN: 'open'>
>>> PullState.OPEN
<PullState.OPEN: 'open'>
>>> PullState.OPEN == "open"
True
>>> print(PullState.OPEN)
open

`Service`

Bases: StrEnum

A str enum class that define valid Git hosting service provider.

Attributes:

Name	Type	Description
`BITBUCKET`	`str`	`"bitbucket"`
`BITBUCKET_SERVER`	`str`	`"bitbucket_server"`
`GITHUB`	`str`	`"github"`
`GITHUB_ENTERPRISE`	`str`	`"github_enterprise"`
`GITLAB`	`str`	`"gitlab"`
`GITLAB_ENTERPRISE`	`str`	`"gitlab_enterprise"`

Examples:

>>> Service("bitbucket")
<Service.BITBUCKET: 'bitbucket'>
>>> Service["BITBUCKET"]
<Service.BITBUCKET: 'bitbucket'>
>>> Service.BITBUCKET
<Service.BITBUCKET: 'bitbucket'>
>>> Service.BITBUCKET == "bitbucket"
True
>>> print(Service.BITBUCKET)
bitbucket