pymbs.enums module

PyMBS is a Python library for use in modeling Mortgage-Backed Securities.

Copyright (C) 2019 Brian Farrell

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.

Contact: brian.farrell@me.com

class pymbs.enums.ExitCode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntEnum

Enumeration of exit codes.

This class implements POSIX error codes, as found in /usr/include/sysexits.h on the Linux platform and described in the manual page for sysexit on BSD systems, including Darwin (macOS).

Additional information is availble from The Linux Documnetation Project at http://tldp.org/LDP/abs/html/exitcodes.html

EX_CANTCREAT = 73
EX_CONFIG = 78
EX_DATAERR = 65
EX_GENERAL = 1
EX_IOERR = 74
EX_NOHOST = 68
EX_NOINPUT = 66
EX_NOPERM = 77
EX_NOUSER = 67
EX_OSERR = 71
EX_OSFILE = 72
EX_PROTOCOL = 76
EX_SIGINT = 130
EX_SOFTWARE = 70
EX_SUCCESS = 0
EX_TEMPFAIL = 75
EX_UNAVAILABLE = 69
EX_USAGE = 64
class pymbs.enums.PrepayBenchmark(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: Enum

docstring for PrepayBenchmark

CPR = 'CPR'
PSA = 'PSA'
class pymbs.enums.URL(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: Enum

docstring for URL

PYMBS_CONFIG = 'https://brianfarrell.gitlab.io/pymbs/pymbs.config.html'
QUANTIZE_HELP = 'https://docs.python.org/3/library/decimal.html#decimal.Decimal.quantize'
SETUP_MODELING = 'https://brianfarrell.gitlab.io/pymbs/setup_modeling.html'