diff --git a/.gitignore b/.gitignore index d9c65a9f..66c1e7ab 100644 --- a/.gitignore +++ b/.gitignore @@ -110,6 +110,9 @@ ENV/ env.bak/ venv.bak/ +# Custom Environments +cpl-env/ + # Spyder project settings .spyderproject .spyproject diff --git a/README.md b/README.md index ac07ceb2..58eb7203 100644 --- a/README.md +++ b/README.md @@ -38,11 +38,16 @@ ### Installation -Install the cpl package +Install the CPL package ```sh pip install sh_cpl --extra-index-url https://pip.sh-edraft.de ``` +Install the CPL CLI +```sh +pip install sh_cpl-cli --extra-index-url https://pip.sh-edraft.de +``` + Create workspace: ```sh cpl new diff --git a/cpl-workspace.json b/cpl-workspace.json new file mode 100644 index 00000000..28077a0b --- /dev/null +++ b/cpl-workspace.json @@ -0,0 +1,9 @@ +{ + "WorkspaceSettings": { + "DefaultProject": "cpl_cli", + "Projects": { + "cpl": "src/cpl/cpl.json", + "cpl_cli": "src/cpl_cli/cpl_cli.json" + } + } +} \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..d0c3cbf1 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/build/doctrees/cli.add.doctree b/docs/build/doctrees/cli.add.doctree new file mode 100644 index 00000000..ed82226a Binary files /dev/null and b/docs/build/doctrees/cli.add.doctree differ diff --git a/docs/build/doctrees/cli.build.doctree b/docs/build/doctrees/cli.build.doctree new file mode 100644 index 00000000..2640833b Binary files /dev/null and b/docs/build/doctrees/cli.build.doctree differ diff --git a/docs/build/doctrees/cli.generate.doctree b/docs/build/doctrees/cli.generate.doctree new file mode 100644 index 00000000..23196c32 Binary files /dev/null and b/docs/build/doctrees/cli.generate.doctree differ diff --git a/docs/build/doctrees/cli.help.doctree b/docs/build/doctrees/cli.help.doctree new file mode 100644 index 00000000..834320d1 Binary files /dev/null and b/docs/build/doctrees/cli.help.doctree differ diff --git a/docs/build/doctrees/cli.install.doctree b/docs/build/doctrees/cli.install.doctree new file mode 100644 index 00000000..6a77325c Binary files /dev/null and b/docs/build/doctrees/cli.install.doctree differ diff --git a/docs/build/doctrees/cli.new.doctree b/docs/build/doctrees/cli.new.doctree new file mode 100644 index 00000000..e35016e9 Binary files /dev/null and b/docs/build/doctrees/cli.new.doctree differ diff --git a/docs/build/doctrees/cli.overview.doctree b/docs/build/doctrees/cli.overview.doctree new file mode 100644 index 00000000..d1895986 Binary files /dev/null and b/docs/build/doctrees/cli.overview.doctree differ diff --git a/docs/build/doctrees/cli.publish.doctree b/docs/build/doctrees/cli.publish.doctree new file mode 100644 index 00000000..594ada0d Binary files /dev/null and b/docs/build/doctrees/cli.publish.doctree differ diff --git a/docs/build/doctrees/cli.remove.doctree b/docs/build/doctrees/cli.remove.doctree new file mode 100644 index 00000000..98c92c20 Binary files /dev/null and b/docs/build/doctrees/cli.remove.doctree differ diff --git a/docs/build/doctrees/cli.start.doctree b/docs/build/doctrees/cli.start.doctree new file mode 100644 index 00000000..9f25efe1 Binary files /dev/null and b/docs/build/doctrees/cli.start.doctree differ diff --git a/docs/build/doctrees/cli.uninstall.doctree b/docs/build/doctrees/cli.uninstall.doctree new file mode 100644 index 00000000..bde41ad4 Binary files /dev/null and b/docs/build/doctrees/cli.uninstall.doctree differ diff --git a/docs/build/doctrees/cli.update.doctree b/docs/build/doctrees/cli.update.doctree new file mode 100644 index 00000000..7533ed14 Binary files /dev/null and b/docs/build/doctrees/cli.update.doctree differ diff --git a/docs/build/doctrees/cli.version.doctree b/docs/build/doctrees/cli.version.doctree new file mode 100644 index 00000000..7fb0d3ec Binary files /dev/null and b/docs/build/doctrees/cli.version.doctree differ diff --git a/docs/build/doctrees/contributing.doctree b/docs/build/doctrees/contributing.doctree new file mode 100644 index 00000000..5225fce9 Binary files /dev/null and b/docs/build/doctrees/contributing.doctree differ diff --git a/docs/build/doctrees/cpl.application.doctree b/docs/build/doctrees/cpl.application.doctree new file mode 100644 index 00000000..40c60815 Binary files /dev/null and b/docs/build/doctrees/cpl.application.doctree differ diff --git a/docs/build/doctrees/cpl.configuration.doctree b/docs/build/doctrees/cpl.configuration.doctree new file mode 100644 index 00000000..0afb489b Binary files /dev/null and b/docs/build/doctrees/cpl.configuration.doctree differ diff --git a/docs/build/doctrees/cpl.console.doctree b/docs/build/doctrees/cpl.console.doctree new file mode 100644 index 00000000..aab2c4d2 Binary files /dev/null and b/docs/build/doctrees/cpl.console.doctree differ diff --git a/docs/build/doctrees/cpl.database.connection.doctree b/docs/build/doctrees/cpl.database.connection.doctree new file mode 100644 index 00000000..de400c60 Binary files /dev/null and b/docs/build/doctrees/cpl.database.connection.doctree differ diff --git a/docs/build/doctrees/cpl.database.context.doctree b/docs/build/doctrees/cpl.database.context.doctree new file mode 100644 index 00000000..a2cc61fa Binary files /dev/null and b/docs/build/doctrees/cpl.database.context.doctree differ diff --git a/docs/build/doctrees/cpl.database.doctree b/docs/build/doctrees/cpl.database.doctree new file mode 100644 index 00000000..f52aa381 Binary files /dev/null and b/docs/build/doctrees/cpl.database.doctree differ diff --git a/docs/build/doctrees/cpl.dependency_injection.doctree b/docs/build/doctrees/cpl.dependency_injection.doctree new file mode 100644 index 00000000..7c1fa94e Binary files /dev/null and b/docs/build/doctrees/cpl.dependency_injection.doctree differ diff --git a/docs/build/doctrees/cpl.doctree b/docs/build/doctrees/cpl.doctree new file mode 100644 index 00000000..67599dd3 Binary files /dev/null and b/docs/build/doctrees/cpl.doctree differ diff --git a/docs/build/doctrees/cpl.environment.doctree b/docs/build/doctrees/cpl.environment.doctree new file mode 100644 index 00000000..524b71e2 Binary files /dev/null and b/docs/build/doctrees/cpl.environment.doctree differ diff --git a/docs/build/doctrees/cpl.logging.doctree b/docs/build/doctrees/cpl.logging.doctree new file mode 100644 index 00000000..01cb954b Binary files /dev/null and b/docs/build/doctrees/cpl.logging.doctree differ diff --git a/docs/build/doctrees/cpl.mailing.doctree b/docs/build/doctrees/cpl.mailing.doctree new file mode 100644 index 00000000..9ece1f8c Binary files /dev/null and b/docs/build/doctrees/cpl.mailing.doctree differ diff --git a/docs/build/doctrees/cpl.time.doctree b/docs/build/doctrees/cpl.time.doctree new file mode 100644 index 00000000..f4c98be8 Binary files /dev/null and b/docs/build/doctrees/cpl.time.doctree differ diff --git a/docs/build/doctrees/cpl.utils.doctree b/docs/build/doctrees/cpl.utils.doctree new file mode 100644 index 00000000..b1298186 Binary files /dev/null and b/docs/build/doctrees/cpl.utils.doctree differ diff --git a/docs/build/doctrees/cpl_cli.doctree b/docs/build/doctrees/cpl_cli.doctree new file mode 100644 index 00000000..d2d16c1f Binary files /dev/null and b/docs/build/doctrees/cpl_cli.doctree differ diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle new file mode 100644 index 00000000..878310a3 Binary files /dev/null and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/getting_started.doctree b/docs/build/doctrees/getting_started.doctree new file mode 100644 index 00000000..a4704eec Binary files /dev/null and b/docs/build/doctrees/getting_started.doctree differ diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree new file mode 100644 index 00000000..054a7eae Binary files /dev/null and b/docs/build/doctrees/index.doctree differ diff --git a/docs/build/doctrees/introduction.doctree b/docs/build/doctrees/introduction.doctree new file mode 100644 index 00000000..14267783 Binary files /dev/null and b/docs/build/doctrees/introduction.doctree differ diff --git a/docs/build/doctrees/modules.doctree b/docs/build/doctrees/modules.doctree new file mode 100644 index 00000000..9bfe3372 Binary files /dev/null and b/docs/build/doctrees/modules.doctree differ diff --git a/docs/build/doctrees/quickstart.doctree b/docs/build/doctrees/quickstart.doctree new file mode 100644 index 00000000..ed8b4dca Binary files /dev/null and b/docs/build/doctrees/quickstart.doctree differ diff --git a/docs/build/doctrees/setup.doctree b/docs/build/doctrees/setup.doctree new file mode 100644 index 00000000..66951101 Binary files /dev/null and b/docs/build/doctrees/setup.doctree differ diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo new file mode 100644 index 00000000..4bf13337 --- /dev/null +++ b/docs/build/html/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 8170277cf12e5442e6180427108a8adf +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/_images/ide-emulate.png b/docs/build/html/_images/ide-emulate.png new file mode 100644 index 00000000..3c6f5a6b Binary files /dev/null and b/docs/build/html/_images/ide-emulate.png differ diff --git a/docs/build/html/_images/ide-src.png b/docs/build/html/_images/ide-src.png new file mode 100644 index 00000000..f778cd46 Binary files /dev/null and b/docs/build/html/_images/ide-src.png differ diff --git a/docs/build/html/_images/ide.png b/docs/build/html/_images/ide.png new file mode 100644 index 00000000..18370cd8 Binary files /dev/null and b/docs/build/html/_images/ide.png differ diff --git a/docs/build/html/_sources/cli.add.md.txt b/docs/build/html/_sources/cli.add.md.txt new file mode 100644 index 00000000..ebadefbe --- /dev/null +++ b/docs/build/html/_sources/cli.add.md.txt @@ -0,0 +1,25 @@ +# cpl add + +## Contents + +- [Description](#description) +- [Arguments](#arguments) + +Removes a project from workspace. + +cpl **add** *<source-project>* *<target-project>*
+cpl **a** *<source-project>* *<target-project>*
+cpl **A** *<source-project>* *<target-project>* + +## Description + +Adds a project reference to given project. + +If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified. + +## Arguments + +| Argument | Description | Value type | +| ------------------------- |:---------------------------------------------------------------:|:----------------:| +| `````` | Name of the project to which the reference has to be added | ```str``` +| `````` | Name of the project to be referenced | ```str``` diff --git a/docs/build/html/_sources/cli.build.md.txt b/docs/build/html/_sources/cli.build.md.txt new file mode 100644 index 00000000..8fdf31b8 --- /dev/null +++ b/docs/build/html/_sources/cli.build.md.txt @@ -0,0 +1,26 @@ +# cpl build + +## Contents + +- [Description](#description) + + +Copies an python app into an output directory named build/ at the given output path. Must be executed within a CPL workspace or project directory + +cpl **build**
+cpl **b**
+cpl **B** + +## Description + +The command can be used to build a project of type "console" or "library". + +The build command copies all included source files to the output directory. You can run the source files in the output directory directly. + +The command is used to prepare the source files for the publish command or to copy them to an target for execution. + + diff --git a/docs/build/html/_sources/cli.generate.md.txt b/docs/build/html/_sources/cli.generate.md.txt new file mode 100644 index 00000000..8c1748f8 --- /dev/null +++ b/docs/build/html/_sources/cli.generate.md.txt @@ -0,0 +1,35 @@ +# cpl generate + +## Contents + +- [Description](#description) +- [Arguments](#arguments) +- [Schematics](#schematics) + +Generate a file based on schematic. + +cpl **generate** *<schematic>* *<name>*
+cpl **g** *<schematic>* *<name>*
+cpl **G** *<schematic>* *<name>* + +## Description + +Generates files based on a schematic. + +## Arguments + +| Argument | Description | Value type | +| ----------------- |:---------------------------------:|:-------------:| +| `````` | The schematic to generate. | ```str``` | +| `````` | The name of the generated file. | ```str``` | + +## Schematics + +| Schematic | Description | Arguments | +| ----------------- |:-------------------:|:----------------:| +| ```abc``` | Abstract base class | `````` +| ```class``` | Class | `````` +| ```enum``` | Enum class | `````` +| ```service``` | Service class | `````` +| ```settings``` | [Configmodel](cpl.configuration) | `````` +| ```thread``` | Thread class | `````` diff --git a/docs/build/html/_sources/cli.help.md.txt b/docs/build/html/_sources/cli.help.md.txt new file mode 100644 index 00000000..4dec5e74 --- /dev/null +++ b/docs/build/html/_sources/cli.help.md.txt @@ -0,0 +1,22 @@ +# cpl help + + + + +Lists available command and their short descriptions. + +cpl **help** *<command>*
+cpl **h** *<command>*
+cpl **H** *<command>* + +## Description + +Lists available command and their short descriptions. + +## Arguments + +| Argument | Description | Value type | +| ----------------- |:-----------------------------:|:-------------:| +| `````` | Shows a help message for this command in the console. | ```str``` | diff --git a/docs/build/html/_sources/cli.install.md.txt b/docs/build/html/_sources/cli.install.md.txt new file mode 100644 index 00000000..b2eaaa47 --- /dev/null +++ b/docs/build/html/_sources/cli.install.md.txt @@ -0,0 +1,23 @@ +# cpl install + +## Contents + +- [Description](#description) +- [Arguments](#arguments) + +Installs given package via pip + +cpl **install** *<package>*
+cpl **i** *<package>*
+cpl **I** *<package>* + +## Description + +Install given package to project via pip. +Without given package it will install the depedencies of the CPL project your in. + +## Arguments + +| Argument | Description | Value type | +| ----------------- |:-----------------------------:|:-------------:| +| `````` | The package to install | ```str``` | diff --git a/docs/build/html/_sources/cli.new.md.txt b/docs/build/html/_sources/cli.new.md.txt new file mode 100644 index 00000000..b849a09e --- /dev/null +++ b/docs/build/html/_sources/cli.new.md.txt @@ -0,0 +1,31 @@ +# cpl new + +## Contents + +- [Description](#description) +- [Arguments](#arguments) +- [Project types](#project-types) + +Generates a workspace and initial project or add a project to workspace. + +cpl **new** *<type>* *<name>*
+cpl **n** *<type>* *<name>*
+cpl **N** *<type>* *<name>* + +## Description + +Generates a workspace and initial project or add a project to workspace. + +If the command is running in a CPL workspace, it will add the new project to the workspace. + +| Argument | Description | Value type | +| ----------------- |:-----------------------------------------------------:|:-------------:| +| `````` | The type of the project, see [types](#project-types) | ```str``` | +| `````` | The name of the project | ```str``` | + +## Project types + +| Project type | Description | +| ----------------- |:-----------------------------:| +| ```console``` | A simple console application | +| ```library``` | A package | diff --git a/docs/build/html/_sources/cli.overview.md.txt b/docs/build/html/_sources/cli.overview.md.txt new file mode 100644 index 00000000..5cd12eca --- /dev/null +++ b/docs/build/html/_sources/cli.overview.md.txt @@ -0,0 +1,53 @@ +# CLI Overview and Command Reference + +## Table of Contents + +1. [Install CPL](setup#install-the-package) +2. [Install CPL CLI](setup#install-the-cli) +3. [Basic workflow](#basic-workflow) +4. [CLI command-language syntax](#cli-command-language-syntax) +5. [Command overview](#command-overview) + +## Basic workflow + +To create, build, and serve a new, basic CPL project on a development server, go to the parent directory of your new workspace use the following commands: + +```sh +cpl new console my-first-project +cd my-first-project +cpl start +``` + +In the terminal you will the output of the app. + +## CLI command-language syntax + +```cpl``` commandNameOrAlias requiredArg ```[optionalsArgs]``` + +- Most commands, and some options, have aliases. Aliases are shown in the syntax statement for each command. +- Arguments are not prefixed. + +### Relative paths + +Options that specify files can be given as absolute paths, or as paths relative to the current working directory, which is generally either the workspace or project root. + +### Schematics + +The cpl generate command takes as an argument the artifact to be generated. In addition to any general options, each artifact defines its own options in a schematic. Schematic options are supplied to the command in the same format as immediate command options. + +## Command overview + +| Command | Alias | Description | +| ----------------------------- |:-------------:|:----------------:| +| [add](cli.add) | a or a | Adds a project reference to given project. +| [build](cli.build) | b or B | Prepares files for publish into an output directory named dist/ at the given output path. Must be executed from within a workspace directory. +| [generate](cli.generate) | g or G | Generate a new file. +| [help](cli.help) | h or H | Lists available command and their short descriptions. +| [install](cli.install) | i or I | With argument installs packages to project, without argument installs project dependencies. +| [new](cli.new) | n or N | Creates new CPL project. +| [publish](cli.publish) | p or P | Prepares files for publish into an output directory named dist/ at the given output path and executes ```setup.py```. Must be executed from within a library workspace directory. +| [remove](cli.remove) | r or R | Removes a project from workspace. +| [start](cli.start) | s or S | Starts CPL project, restarting on file changes. +| [uninstall](cli.uninstall) | ui or UI | Uninstalls packages from project. +| [update](cli.update) | u or U | Update CPL and project dependencies. +| [version](cli.version) | v or V | Outputs CPL CLI version. diff --git a/docs/build/html/_sources/cli.publish.md.txt b/docs/build/html/_sources/cli.publish.md.txt new file mode 100644 index 00000000..a6c3884a --- /dev/null +++ b/docs/build/html/_sources/cli.publish.md.txt @@ -0,0 +1,27 @@ +# cpl publish + +## Contents + +- [Description](#description) + + +Prepares files for publish into an output directory named dist/ at the given output path and executes ```setup.py```. + +cpl **publish**
+cpl **p**
+cpl **P** + +## Description + +The command can be used to publish a project of type "console" or "library". + +The publish command builds the source files and then creates an ```setup.py``` with data from ```cpl.json```. +The command executes the ```setup.py``` and removes all source files with the ```setup.py``` from the 'publish/' directory. + +Generated files of ```setup.py``` are in the 'publish/setup/' directory. + + \ No newline at end of file diff --git a/docs/build/html/_sources/cli.remove.md.txt b/docs/build/html/_sources/cli.remove.md.txt new file mode 100644 index 00000000..32934904 --- /dev/null +++ b/docs/build/html/_sources/cli.remove.md.txt @@ -0,0 +1,27 @@ +# cpl remove + +## Contents + +- [Description](#description) +- [Arguments](#arguments) + +Removes a project from workspace. + +cpl **remove** *<project>*
+cpl **r** *<project>*
+cpl **R** *<project>* + +## Description + +The command can be used to publish a project of type "console" or "library". + +The publish command builds the source files and then creates an ```setup.py``` with data from ```cpl.json```. +The command executes the ```setup.py``` and removes all source files with the ```setup.py``` from the 'publish/' directory. + +Generated files of ```setup.py``` are in the 'publish/setup/' directory. + +## Arguments + +| Argument | Description | Value type | +| ------------------------- |:-------------------------------------:|:----------------:| +| `````` | The name of the project to delete | ```str``` diff --git a/docs/build/html/_sources/cli.start.md.txt b/docs/build/html/_sources/cli.start.md.txt new file mode 100644 index 00000000..2b067bfb --- /dev/null +++ b/docs/build/html/_sources/cli.start.md.txt @@ -0,0 +1,7 @@ +# cpl start + +Starts your application, restarting on file changes. + +cpl **start**
+cpl **s**
+cpl **S** diff --git a/docs/build/html/_sources/cli.uninstall.md.txt b/docs/build/html/_sources/cli.uninstall.md.txt new file mode 100644 index 00000000..8646615d --- /dev/null +++ b/docs/build/html/_sources/cli.uninstall.md.txt @@ -0,0 +1,22 @@ +# cpl uninstall + +## Contents + +- [Description](#description) +- [Arguments](#arguments) + +Uninstalls given package via pip + +cpl **uninstall** *<package>*
+cpl **ui** *<package>*
+cpl **UI** *<package>* + +## Description + +Uninstall given package from project via pip. + +## Arguments + +| Argument | Description | Value type | +| ----------------- |:-----------------------------:|:-------------:| +| `````` | The package to uninstall | ```str``` | diff --git a/docs/build/html/_sources/cli.update.md.txt b/docs/build/html/_sources/cli.update.md.txt new file mode 100644 index 00000000..586c32c7 --- /dev/null +++ b/docs/build/html/_sources/cli.update.md.txt @@ -0,0 +1,7 @@ +# cpl update + +Updates the CPL and project dependencies. + +cpl **update**
+cpl **u**
+cpl **U** diff --git a/docs/build/html/_sources/cli.version.md.txt b/docs/build/html/_sources/cli.version.md.txt new file mode 100644 index 00000000..4c8fcbe4 --- /dev/null +++ b/docs/build/html/_sources/cli.version.md.txt @@ -0,0 +1,7 @@ +# cpl version + +Lists the version of CPL, CPL CLI and all installed packages from pip. + +cpl **version**
+cpl **v**
+cpl **V** diff --git a/docs/build/html/_sources/contributing.md.txt b/docs/build/html/_sources/contributing.md.txt new file mode 100644 index 00000000..85456726 --- /dev/null +++ b/docs/build/html/_sources/contributing.md.txt @@ -0,0 +1,111 @@ +# Contributing to CPL + +We would love for you to contribute to CPL and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow: + +- [Issuses and Bugs](#found-a-bug) +- [Feature Request](#feature-request) +- [Submission Guidelines](#submission-guidelines) +- [Coding Rules](#coding-rules) +- [License](#license) + +## Found a Bug? + +If you find a bug in the source code, you can help us by [submitting an issue](#submitting-an-issue) to our [Gitea Repository][gitea-repo]. Even better, you can [submit a Pull Request](#submitting-a-pull-request) with a fix. + +## Feature Request + +You can request a new feature by submitting an issue to our [Gitea Repository][gitea-repo]. If you would like to implement a new feature, please consider the size of the change in order to determine the right steps to proceed: + +For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project. + +Note: Adding a new topic to the documentation, or significantly re-writing a topic, counts as a major feature. + +Small Features can be crafted and directly submitted as a [Pull Request](#submit-pr). + +## Submission Guidelines + +### Submitting an Issue + +Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available. + +We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we require that you provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions. + +A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem. + +We require a minimal reproduction to save maintainers' time and ultimately be able to fix more bugs. Often, developers find coding problems themselves while preparing a minimal reproduction. We understand that sometimes it might be hard to extract essential bits of code from a larger codebase but we really need to isolate the problem before we can fix it. + +Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you, we are going to close an issue that doesn't have enough info to be reproduced. + +### Submitting a Pull Request + +Before you submit your Pull Request (PR) consider the following guidelines: + +1. Search the [repository][gitea-repo] for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts. + +2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design upfront helps to ensure that we're ready to accept your work. + +3. Fork the sh-edraft.de/sh_cpl repo. + +4. In your forked repository, make your changes in a new git branch: + + ```sh + git checkout -b my-fix-branch master + ``` + +5. Create your patch, including appropriate test cases. + + + +6. Commit your changes. + + ```sh + git commit --all + ``` + + Note: the optional commit ```-a``` command line option will automatically "add" and "rm" edited files. + +7. Push your branch to the [repository][gitea-repo]: + + ```sh + git push origin my-fix-branch + ``` + +8. In Gitea, send a pull request to sh_cpl:master + +### Reviewing a Pull Request + +The sh-edraft.de team reserves the right not to accept pull requests from community members who haven't been good citizens of the community. Such behavior includes not following the CPL [coding rules](#coding-rules) and applies within or outside of CPL managed channels. + +#### Addressing review feedback + +If we ask for changes via code reviews then: + +1. Make the required updates to the code. + +2. Create a fixup commit and push to your repository (this will update your Pull Request): + + ```sh + git commit --all --fixup HEAD + git push + ``` + +That's it! Thank you for your contribution! + +## Coding Rules + +To ensure consistency throughout the source code, keep these rules in mind as you are working: + +- All features or bug fixes must be tested by one or more unit-tests. + +- All public API methods must be documented. + +- We follow [PEP 8 -- Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/). + +## License + +By contributing, you agree that your contributions will be licensed under its MIT License. +See [LICENSE](https://git.sh-edraft.de/sh-edraft.de/sh_cpl/src/branch/master/LICENSE) + + +[gitea-repo]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl/ +[coding-rules]: / diff --git a/docs/build/html/_sources/cpl.application.rst.txt b/docs/build/html/_sources/cpl.application.rst.txt new file mode 100644 index 00000000..57749fb4 --- /dev/null +++ b/docs/build/html/_sources/cpl.application.rst.txt @@ -0,0 +1,34 @@ +cpl.application +======================= + +cpl.application.application\_abc +--------------------------------------- + +.. automodule:: cpl.application.application_abc + :members: + :undoc-members: + :show-inheritance: + +cpl.application.application\_builder +------------------------------------------- + +.. automodule:: cpl.application.application_builder + :members: + :undoc-members: + :show-inheritance: + +cpl.application.application\_builder\_abc +------------------------------------------------ + +.. automodule:: cpl.application.application_builder_abc + :members: + :undoc-members: + :show-inheritance: + +cpl.application.startup\_abc +----------------------------------- + +.. automodule:: cpl.application.startup_abc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/cpl.configuration.rst.txt b/docs/build/html/_sources/cpl.configuration.rst.txt new file mode 100644 index 00000000..a9c7cc87 --- /dev/null +++ b/docs/build/html/_sources/cpl.configuration.rst.txt @@ -0,0 +1,42 @@ +cpl.configuration +========================= + +cpl.configuration.configuration +-------------------------------------- + +.. automodule:: cpl.configuration.configuration + :members: + :undoc-members: + :show-inheritance: + +cpl.configuration.configuration\_abc +------------------------------------------- + +.. automodule:: cpl.configuration.configuration_abc + :members: + :undoc-members: + :show-inheritance: + +cpl.configuration.configuration\_model\_abc +-------------------------------------------------- + +.. automodule:: cpl.configuration.configuration_model_abc + :members: + :undoc-members: + :show-inheritance: + +cpl.configuration.configuration\_variable\_name\_enum +------------------------------------------------------------ + +.. automodule:: cpl.configuration.configuration_variable_name_enum + :members: + :undoc-members: + :show-inheritance: + +cpl.configuration.console\_argument +------------------------------------------ + +.. automodule:: cpl.configuration.console_argument + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/cpl.console.rst.txt b/docs/build/html/_sources/cpl.console.rst.txt new file mode 100644 index 00000000..ad4c2e8f --- /dev/null +++ b/docs/build/html/_sources/cpl.console.rst.txt @@ -0,0 +1,42 @@ +cpl.console +=================== + +cpl.console.background\_color\_enum +------------------------------------------ + +.. automodule:: cpl.console.background_color_enum + :members: + :undoc-members: + :show-inheritance: + +cpl.console.console +-------------------------- + +.. automodule:: cpl.console.console + :members: + :undoc-members: + :show-inheritance: + +cpl.console.console\_call +-------------------------------- + +.. automodule:: cpl.console.console_call + :members: + :undoc-members: + :show-inheritance: + +cpl.console.foreground\_color\_enum +------------------------------------------ + +.. automodule:: cpl.console.foreground_color_enum + :members: + :undoc-members: + :show-inheritance: + +cpl.console.spinner\_thread +---------------------------------- + +.. automodule:: cpl.console.spinner_thread + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/cpl.database.connection.rst.txt b/docs/build/html/_sources/cpl.database.connection.rst.txt new file mode 100644 index 00000000..1cff3f96 --- /dev/null +++ b/docs/build/html/_sources/cpl.database.connection.rst.txt @@ -0,0 +1,18 @@ +cpl.database.connection +=============================== + +cpl.database.connection.database\_connection +--------------------------------------------------- + +.. automodule:: cpl.database.connection.database_connection + :members: + :undoc-members: + :show-inheritance: + +cpl.database.connection.database\_connection\_abc +-------------------------------------------------------- + +.. automodule:: cpl.database.connection.database_connection_abc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/cpl.database.context.rst.txt b/docs/build/html/_sources/cpl.database.context.rst.txt new file mode 100644 index 00000000..cbfa4901 --- /dev/null +++ b/docs/build/html/_sources/cpl.database.context.rst.txt @@ -0,0 +1,18 @@ +cpl.database.context +============================ + +cpl.database.context.database\_context +--------------------------------------------- + +.. automodule:: cpl.database.context.database_context + :members: + :undoc-members: + :show-inheritance: + +cpl.database.context.database\_context\_abc +-------------------------------------------------- + +.. automodule:: cpl.database.context.database_context_abc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/cpl.database.rst.txt b/docs/build/html/_sources/cpl.database.rst.txt new file mode 100644 index 00000000..b550b32a --- /dev/null +++ b/docs/build/html/_sources/cpl.database.rst.txt @@ -0,0 +1,35 @@ +cpl.database +==================== + +.. toctree:: + :maxdepth: 4 + + cpl.database.connection + cpl.database.context + +Submodules +---------- + +cpl.database.database\_model +----------------------------------- + +.. automodule:: cpl.database.database_model + :members: + :undoc-members: + :show-inheritance: + +cpl.database.database\_settings +-------------------------------------- + +.. automodule:: cpl.database.database_settings + :members: + :undoc-members: + :show-inheritance: + +cpl.database.database\_settings\_name\_enum +-------------------------------------------------- + +.. automodule:: cpl.database.database_settings_name_enum + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/cpl.dependency_injection.rst.txt b/docs/build/html/_sources/cpl.dependency_injection.rst.txt new file mode 100644 index 00000000..11ec1428 --- /dev/null +++ b/docs/build/html/_sources/cpl.dependency_injection.rst.txt @@ -0,0 +1,50 @@ +cpl.dependency\_injection +================================= + +cpl.dependency\_injection.service\_collection +---------------------------------------------------- + +.. automodule:: cpl.dependency_injection.service_collection + :members: + :undoc-members: + :show-inheritance: + +cpl.dependency\_injection.service\_collection\_abc +--------------------------------------------------------- + +.. automodule:: cpl.dependency_injection.service_collection_abc + :members: + :undoc-members: + :show-inheritance: + +cpl.dependency\_injection.service\_descriptor +---------------------------------------------------- + +.. automodule:: cpl.dependency_injection.service_descriptor + :members: + :undoc-members: + :show-inheritance: + +cpl.dependency\_injection.service\_lifetime\_enum +-------------------------------------------------------- + +.. automodule:: cpl.dependency_injection.service_lifetime_enum + :members: + :undoc-members: + :show-inheritance: + +cpl.dependency\_injection.service\_provider +-------------------------------------------------- + +.. automodule:: cpl.dependency_injection.service_provider + :members: + :undoc-members: + :show-inheritance: + +cpl.dependency\_injection.service\_provider\_abc +------------------------------------------------------- + +.. automodule:: cpl.dependency_injection.service_provider_abc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/cpl.environment.rst.txt b/docs/build/html/_sources/cpl.environment.rst.txt new file mode 100644 index 00000000..1bb5bd1c --- /dev/null +++ b/docs/build/html/_sources/cpl.environment.rst.txt @@ -0,0 +1,26 @@ +cpl.environment +======================= + +cpl.environment.application\_environment +----------------------------------------------- + +.. automodule:: cpl.environment.application_environment + :members: + :undoc-members: + :show-inheritance: + +cpl.environment.application\_environment\_abc +---------------------------------------------------- + +.. automodule:: cpl.environment.application_environment_abc + :members: + :undoc-members: + :show-inheritance: + +cpl.environment.environment\_name\_enum +---------------------------------------------- + +.. automodule:: cpl.environment.environment_name_enum + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/cpl.logging.rst.txt b/docs/build/html/_sources/cpl.logging.rst.txt new file mode 100644 index 00000000..aa5880d8 --- /dev/null +++ b/docs/build/html/_sources/cpl.logging.rst.txt @@ -0,0 +1,42 @@ +cpl.logging +=================== + +cpl.logging.logger\_abc +------------------------------ + +.. automodule:: cpl.logging.logger_abc + :members: + :undoc-members: + :show-inheritance: + +cpl.logging.logger\_service +---------------------------------- + +.. automodule:: cpl.logging.logger_service + :members: + :undoc-members: + :show-inheritance: + +cpl.logging.logging\_level\_enum +--------------------------------------- + +.. automodule:: cpl.logging.logging_level_enum + :members: + :undoc-members: + :show-inheritance: + +cpl.logging.logging\_settings +------------------------------------ + +.. automodule:: cpl.logging.logging_settings + :members: + :undoc-members: + :show-inheritance: + +cpl.logging.logging\_settings\_name\_enum +------------------------------------------------ + +.. automodule:: cpl.logging.logging_settings_name_enum + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/cpl.mailing.rst.txt b/docs/build/html/_sources/cpl.mailing.rst.txt new file mode 100644 index 00000000..fb00a96a --- /dev/null +++ b/docs/build/html/_sources/cpl.mailing.rst.txt @@ -0,0 +1,42 @@ +cpl.mailing +=================== + +cpl.mailing.email +------------------------ + +.. automodule:: cpl.mailing.email + :members: + :undoc-members: + :show-inheritance: + +cpl.mailing.email\_client\_abc +------------------------------------- + +.. automodule:: cpl.mailing.email_client_abc + :members: + :undoc-members: + :show-inheritance: + +cpl.mailing.email\_client\_service +----------------------------------------- + +.. automodule:: cpl.mailing.email_client_service + :members: + :undoc-members: + :show-inheritance: + +cpl.mailing.email\_client\_settings +------------------------------------------ + +.. automodule:: cpl.mailing.email_client_settings + :members: + :undoc-members: + :show-inheritance: + +cpl.mailing.email\_client\_settings\_name\_enum +------------------------------------------------------ + +.. automodule:: cpl.mailing.email_client_settings_name_enum + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/cpl.rst.txt b/docs/build/html/_sources/cpl.rst.txt new file mode 100644 index 00000000..bcc31ee0 --- /dev/null +++ b/docs/build/html/_sources/cpl.rst.txt @@ -0,0 +1,16 @@ +API Reference +=========== + +.. toctree:: + :maxdepth: 4 + + cpl.application + cpl.configuration + cpl.console + cpl.database + cpl.dependency_injection + cpl.environment + cpl.logging + cpl.mailing + cpl.time + cpl.utils diff --git a/docs/build/html/_sources/cpl.time.rst.txt b/docs/build/html/_sources/cpl.time.rst.txt new file mode 100644 index 00000000..7389b8a3 --- /dev/null +++ b/docs/build/html/_sources/cpl.time.rst.txt @@ -0,0 +1,18 @@ +cpl.time +================ + +cpl.time.time\_format\_settings +-------------------------------------- + +.. automodule:: cpl.time.time_format_settings + :members: + :undoc-members: + :show-inheritance: + +cpl.time.time\_format\_settings\_names\_enum +--------------------------------------------------- + +.. automodule:: cpl.time.time_format_settings_names_enum + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/cpl.utils.rst.txt b/docs/build/html/_sources/cpl.utils.rst.txt new file mode 100644 index 00000000..4ccbfcf6 --- /dev/null +++ b/docs/build/html/_sources/cpl.utils.rst.txt @@ -0,0 +1,26 @@ +cpl.utils +================= + +cpl.utils.credential\_manager +------------------------------------ + +.. automodule:: cpl.utils.credential_manager + :members: + :undoc-members: + :show-inheritance: + +cpl.utils.pip +-------------------- + +.. automodule:: cpl.utils.pip + :members: + :undoc-members: + :show-inheritance: + +cpl.utils.string +----------------------- + +.. automodule:: cpl.utils.string + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/cpl_cli.rst.txt b/docs/build/html/_sources/cpl_cli.rst.txt new file mode 100644 index 00000000..338ba5c2 --- /dev/null +++ b/docs/build/html/_sources/cpl_cli.rst.txt @@ -0,0 +1,19 @@ +CLI Reference +============= + +.. toctree:: + :maxdepth: 4 + + cli.overview + cli.add + cli.build + cli.generate + cli.help + cli.install + cli.new + cli.publish + cli.remove + cli.start + cli.uninstall + cli.update + cli.version \ No newline at end of file diff --git a/docs/build/html/_sources/getting_started.rst.txt b/docs/build/html/_sources/getting_started.rst.txt new file mode 100644 index 00000000..ee746fb1 --- /dev/null +++ b/docs/build/html/_sources/getting_started.rst.txt @@ -0,0 +1,9 @@ +Getting started +=============== + +.. toctree:: + :maxdepth: 4 + + quickstart + setup + diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt new file mode 100644 index 00000000..4bf52fab --- /dev/null +++ b/docs/build/html/_sources/index.rst.txt @@ -0,0 +1,24 @@ +.. Common Python Library documentation master file, created by + sphinx-quickstart on Wed Apr 14 10:25:36 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Introduction to the CPL Docs +============================ + +The Common Python Library (CPL) is a package for python and a development platform meant to help you create simple and efficient server and desktop applications. + +This CPL docs help you learn, understand and use the package. From your first application to complex apps for enterprises. + +Manuals +--------- + +These pages go into great detail about everything the Library can do. + +.. toctree:: + :maxdepth: 1 + + introduction + getting_started + cpl + cpl_cli diff --git a/docs/build/html/_sources/introduction.md.txt b/docs/build/html/_sources/introduction.md.txt new file mode 100644 index 00000000..eb36b40f --- /dev/null +++ b/docs/build/html/_sources/introduction.md.txt @@ -0,0 +1,12 @@ +# Introduction to the CPL Docs + +The Common Python Library (CPL) is a package for python and a development platform meant to help you create simple and efficient server and desktop applications. + +This CPL docs help you learn, understand and use the package. From your first application to complex apps for enterprises. + +## Explore + +- [Getting started](quickstart) +- [Setup](setup) +- [API Reference](cpl) +- [CLI Reference](cli.overview) diff --git a/docs/build/html/_sources/modules.rst.txt b/docs/build/html/_sources/modules.rst.txt new file mode 100644 index 00000000..962df7d9 --- /dev/null +++ b/docs/build/html/_sources/modules.rst.txt @@ -0,0 +1,9 @@ +cpl +=== + +.. toctree:: + :maxdepth: 4 + + getting_started + cpl + cpl_cli diff --git a/docs/build/html/_sources/quickstart.md.txt b/docs/build/html/_sources/quickstart.md.txt new file mode 100644 index 00000000..0b75384e --- /dev/null +++ b/docs/build/html/_sources/quickstart.md.txt @@ -0,0 +1,210 @@ +# Getting started with CPL + +Welcome to CPL! + +This tutorial introduces you to the essentials of the CPL package by walking through building an console based app. + +## Table of Contents + +1. [Prerequisites](#prerequisites) +2. [Create the project](#create-the-project) +3. [Create a menu](#create-a-menu) +4. [What's next](#whats-next) + +## Prerequisites + +To get most out of this tutorial you should already have a basic understanding of the following. + +- [Python][python] + +Also you need to have the following installed. + +- [Python][python] +- [Pip][pip-url] +- [CPL](setup) +- [CPL-CLI](setup) + +## Create the project + +To create the sample project to the following: + +1. Open a terminal +2. Run + + ```sh + cpl new console sample-project + ``` + +3. We don't want to use Application base or Dependency injection: + + ```sh + Do you want to use application base? (y/n) n + + Do you want to use service providing? (y/n) n + ``` + + The ouput should look like this: + + ```sh + Creating sample-project/LICENSE done + Creating sample-project/README.md done + Creating sample-project/src/tests/__init__.py done + Creating sample-project/appsettings.json done + Creating sample-project/src/sample-project/__init__.py done + Creating sample-project/src/sample-projectmain.py done + ``` + +4. Open the project with an IDE like VS Code or PyCharm + + ![IDE](images/ide.png) + +5. Set the 'src' directory as source folder + + ![IDE set src folder](images/ide-src.png) + +6. Run the application + + You should see an output like: + + ```sh + Hello World + ``` + +7. In PyCharm you have to enable ```Emulate terminal in output console```! + + ![IDE emulate console](images/ide-emulate.png) + +## Create a menu + +1. Open the 'sample-project/main.py' + +2. Change 'Hello World' to 'Password generator:' in line 5 + +3. Add ```Console.select``` as follows: + + ```py + from cpl.console import Console + + + def main(): + Console.write_line('Password generator:') + options = [ + 'Only lower case', + 'Only upper case', + 'Lower and upper case' + 'Exit' + ] + option = Console.select('>', 'Select option: ', options) + + + if __name__ == '__main__': + main() + + ``` + +4. Get Id of the selected option: + + ```py + index = options.index(option) + ``` + +5. Create the generate function as follows: + + ```py + def generate_password(letters: str, length: int) -> str: + return ''.join(random.choice(letters) for i in range(length)) + ``` + + Add imports: + + ```py + import random + import string + ``` + +6. Get length of the password: + + ```py + length = int(Console.read('Length: ')) + ``` + +7. Validate the selected option: + + ```py + index = options.index(option) + letters = '' + + if index == 0: + letters = string.ascii_lowercase + elif index == 1: + letters = string.ascii_uppercase + elif index == 2: + letters = string.ascii_letters + elif index == len(options) - 1: + exit() + ``` + +8. Print the generated password: + + ```py + Console.write_line('Password: ', generate_password(letters, length)) + ``` + +9. The full 'sample-project/main.py': + + ```py + import random + import string + + from cpl.console import Console + + + def generate_password(letters: str, length: int) -> str: + return ''.join(random.choice(letters) for i in range(length)) + + + def main(): + Console.write_line('Password generator:') + options = [ + 'Only lower case', + 'Only upper case', + 'Lower and upper case', + 'Exit' + ] + option = Console.select('>', 'Select option: ', options) + + length = int(Console.read('Length: ')) + + index = options.index(option) + letters = '' + if index == 0: + letters = string.ascii_lowercase + elif index == 1: + letters = string.ascii_uppercase + elif index == 2: + letters = string.ascii_letters + elif index == len(options) - 1: + exit() + + Console.write_line('Password: ', generate_password(letters, length)) + + + if __name__ == '__main__': + main() + + ``` + +## What's next + +In this section, you've created an application that uses user input to generate a password. + +To continue exploring CPL and developing applications: + +- [Application base](cpl.application) +- [Dependency injection](cpl.dependency_injection) +- [Console](cpl.console) + + +[pip-url]: https://pip.sh-edraft.de +[python]: https://www.python.org/ +[pip]: https://pypi.org/project/pip/ diff --git a/docs/build/html/_sources/setup.md.txt b/docs/build/html/_sources/setup.md.txt new file mode 100644 index 00000000..29e6f086 --- /dev/null +++ b/docs/build/html/_sources/setup.md.txt @@ -0,0 +1,104 @@ +# Setting up the local environment and workspace + +## Table of Contents + +1. [Prerequisites](#prerequisites) +2. [Install the package](#install-the-package) +3. [Install the CLI](#install-the-cli) +4. [Create a initial application](#create-initial-console-app) +5. [Create a initial library](#create-initial-library) +6. [Start the application](#start-the-app) +7. [What's next](#whats-next) + +## Prerequisites + +To get most out of this tutorial you should already have a basic understanding of the following. + +- [Python][python] + +Also you need to have the following installed. + +- [Python][python] +- [Pip][pip-url] + +## Install the package + +To install the package, open a terminal window and run the following command: + +```sh +pip install sh_cpl --extra-index-url https://pip.sh-edraft.de +``` + +## Install the CLI + +You use the CPL CLI to create projects, generate application and library code. You also use the CLI to build and publish your python packages. + +To install the CLI, open a terminal window and run the following command: + +```sh +pip install sh_cpl-cli --extra-index-url https://pip.sh-edraft.de +``` + +## Create initial console app + +You develop apps and packages in the context of an CPL project which is defined in an cpl.json. + +1. Run the CLI command ```cpl new console``` and provide the name my-app, as shown here: + + ```sh + cpl new console my-app + ``` + +2. The cpl new command prompts you for information about features to include in the initial app. Decline the defaults by enter 'n' and press the Enter key. + +The CLI create a new workspace and a simple 'Hello World' app, ready to run. + +## Create initial library + +You develop apps and packages in the context of an CPL project which is defined in an cpl.json. + +1. Run the CLI command ```cpl new library``` and provide the name my-lib, as shown here: + + ```sh + cpl new library my-lib + ``` + +2. The cpl new command prompts you for information about features to include in the initial library. Decline the defaults by enter 'n' and press the Enter key. + +The CLI create a new workspace and a simple 'Hello World' library with CLI, ready to run. + +## Start the app + +The CLI includes a live development server, so that you can run your app locally. + +1. Open a terminal window + +2. To navigate to your project workspace, run the following command: + + ```sh + cd /path/to/project/name + ``` + +3. To run the app run: + + ```sh + cpl start + ``` + +The ```cpl start``` command launches the server, watches your source files, and restarts the app as you make chnages to thoses source files. + +If your installation and setup was successful, you should see a output similar to the following: + +```sh +Hello World +``` + +## What's next + +- To learn more about the CPL CLI, see the [CLI Overview](cli.overview) +- Fore more informations about the Pyhton files generated by ```cpl new```, see [New Command](cli.new) + + +[pip-url]: https://pip.sh-edraft.de +[python]: https://www.python.org/ +[pip]: https://pypi.org/project/pip/ diff --git a/docs/build/html/_static/basic.css b/docs/build/html/_static/basic.css new file mode 100644 index 00000000..be19270e --- /dev/null +++ b/docs/build/html/_static/basic.css @@ -0,0 +1,856 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/docs/build/html/_static/css/badge_only.css b/docs/build/html/_static/css/badge_only.css new file mode 100644 index 00000000..e380325b --- /dev/null +++ b/docs/build/html/_static/css/badge_only.css @@ -0,0 +1 @@ +.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff b/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 b/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff b/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 b/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.eot b/docs/build/html/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/docs/build/html/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.svg b/docs/build/html/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/docs/build/html/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.ttf b/docs/build/html/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/docs/build/html/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.woff b/docs/build/html/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/docs/build/html/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.woff2 b/docs/build/html/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/docs/build/html/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/docs/build/html/_static/css/fonts/lato-bold-italic.woff b/docs/build/html/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-bold-italic.woff differ diff --git a/docs/build/html/_static/css/fonts/lato-bold-italic.woff2 b/docs/build/html/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/docs/build/html/_static/css/fonts/lato-bold.woff b/docs/build/html/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-bold.woff differ diff --git a/docs/build/html/_static/css/fonts/lato-bold.woff2 b/docs/build/html/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-bold.woff2 differ diff --git a/docs/build/html/_static/css/fonts/lato-normal-italic.woff b/docs/build/html/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-normal-italic.woff differ diff --git a/docs/build/html/_static/css/fonts/lato-normal-italic.woff2 b/docs/build/html/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/docs/build/html/_static/css/fonts/lato-normal.woff b/docs/build/html/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-normal.woff differ diff --git a/docs/build/html/_static/css/fonts/lato-normal.woff2 b/docs/build/html/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-normal.woff2 differ diff --git a/docs/build/html/_static/css/theme.css b/docs/build/html/_static/css/theme.css new file mode 100644 index 00000000..8cd4f101 --- /dev/null +++ b/docs/build/html/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a,.wy-menu-vertical li.current>a span.toctree-expand:before,.wy-menu-vertical li.on a,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li span.toctree-expand:before,.wy-nav-top a,.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li span.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p.caption .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a span.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-left.toctree-expand,.wy-menu-vertical li span.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p.caption .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a span.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-right.toctree-expand,.wy-menu-vertical li span.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p.caption .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a span.pull-left.toctree-expand,.wy-menu-vertical li.on a span.pull-left.toctree-expand,.wy-menu-vertical li span.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p.caption .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a span.pull-right.toctree-expand,.wy-menu-vertical li.on a span.pull-right.toctree-expand,.wy-menu-vertical li span.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li span.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li span.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li span.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li a span.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li span.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p.caption .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a span.toctree-expand,.btn .wy-menu-vertical li.on a span.toctree-expand,.btn .wy-menu-vertical li span.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p.caption .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a span.toctree-expand,.nav .wy-menu-vertical li.on a span.toctree-expand,.nav .wy-menu-vertical li span.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p.caption .btn .headerlink,.rst-content p.caption .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn span.toctree-expand,.wy-menu-vertical li.current>a .btn span.toctree-expand,.wy-menu-vertical li.current>a .nav span.toctree-expand,.wy-menu-vertical li .nav span.toctree-expand,.wy-menu-vertical li.on a .btn span.toctree-expand,.wy-menu-vertical li.on a .nav span.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p.caption .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li span.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p.caption .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li span.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p.caption .btn .fa-large.headerlink,.rst-content p.caption .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn span.fa-large.toctree-expand,.wy-menu-vertical li .nav span.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p.caption .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li span.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p.caption .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li span.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p.caption .btn .fa-spin.headerlink,.rst-content p.caption .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn span.fa-spin.toctree-expand,.wy-menu-vertical li .nav span.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p.caption .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li span.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p.caption .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li span.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p.caption .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li span.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p.caption .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini span.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol li,.rst-content ol.arabic li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content ol.arabic li p:last-child,.rst-content ol.arabic li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol li ul li,.rst-content ol.arabic li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs li{display:inline-block}.wy-breadcrumbs li.wy-breadcrumbs-aside{float:right}.wy-breadcrumbs li a{display:inline-block;padding:5px}.wy-breadcrumbs li a:first-child{padding-left:0}.rst-content .wy-breadcrumbs li tt,.wy-breadcrumbs li .rst-content tt,.wy-breadcrumbs li code{padding:5px;border:none;background:none}.rst-content .wy-breadcrumbs li tt.literal,.wy-breadcrumbs li .rst-content tt.literal,.wy-breadcrumbs li code.literal{color:#404040}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li span.toctree-expand{display:block;float:left;margin-left:-1.2em;font-size:.8em;line-height:1.6em;color:#4d4d4d}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover span.toctree-expand,.wy-menu-vertical li.on a:hover span.toctree-expand{color:grey}.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand{display:block;font-size:.8em;line-height:1.6em;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover span.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 span.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 span.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover span.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active span.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p.caption .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p.caption .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version span.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content img{max-width:100%;height:auto}.rst-content div.figure{margin-bottom:24px}.rst-content div.figure p.caption{font-style:italic}.rst-content div.figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp{user-select:none;pointer-events:none}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink{visibility:hidden;font-size:14px}.rst-content .code-block-caption .headerlink:after,.rst-content .toctree-wrapper>p.caption .headerlink:after,.rst-content dl dt .headerlink:after,.rst-content h1 .headerlink:after,.rst-content h2 .headerlink:after,.rst-content h3 .headerlink:after,.rst-content h4 .headerlink:after,.rst-content h5 .headerlink:after,.rst-content h6 .headerlink:after,.rst-content p.caption .headerlink:after,.rst-content table>caption .headerlink:after{content:"\f0c1";font-family:FontAwesome}.rst-content .code-block-caption:hover .headerlink:after,.rst-content .toctree-wrapper>p.caption:hover .headerlink:after,.rst-content dl dt:hover .headerlink:after,.rst-content h1:hover .headerlink:after,.rst-content h2:hover .headerlink:after,.rst-content h3:hover .headerlink:after,.rst-content h4:hover .headerlink:after,.rst-content h5:hover .headerlink:after,.rst-content h6:hover .headerlink:after,.rst-content p.caption:hover .headerlink:after,.rst-content table>caption:hover .headerlink:after{visibility:visible}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .hlist{width:100%}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl dt span.classifier:before{content:" : "}html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.field-list>dt:after,html.writer-html5 .rst-content dl.footnote>dt:after{content:":"}html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.footnote>dt>span.brackets{margin-right:.5rem}html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{font-style:italic}html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.footnote>dd p,html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{font-size:inherit;line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code,html.writer-html4 .rst-content dl:not(.docutils) tt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel{border:1px solid #7fbbe3;background:#e7f2fa;font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/docs/build/html/_static/doctools.js b/docs/build/html/_static/doctools.js new file mode 100644 index 00000000..61ac9d26 --- /dev/null +++ b/docs/build/html/_static/doctools.js @@ -0,0 +1,321 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('

' + _('Hide Search Matches') + '

') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey + && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js new file mode 100644 index 00000000..2fa8c97f --- /dev/null +++ b/docs/build/html/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/docs/build/html/_static/file.png b/docs/build/html/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/docs/build/html/_static/file.png differ diff --git a/docs/build/html/_static/fonts/Inconsolata-Bold.ttf b/docs/build/html/_static/fonts/Inconsolata-Bold.ttf new file mode 100644 index 00000000..809c1f58 Binary files /dev/null and b/docs/build/html/_static/fonts/Inconsolata-Bold.ttf differ diff --git a/docs/build/html/_static/fonts/Inconsolata-Regular.ttf b/docs/build/html/_static/fonts/Inconsolata-Regular.ttf new file mode 100644 index 00000000..fc981ce7 Binary files /dev/null and b/docs/build/html/_static/fonts/Inconsolata-Regular.ttf differ diff --git a/docs/build/html/_static/fonts/Inconsolata.ttf b/docs/build/html/_static/fonts/Inconsolata.ttf new file mode 100644 index 00000000..4b8a36d2 Binary files /dev/null and b/docs/build/html/_static/fonts/Inconsolata.ttf differ diff --git a/docs/build/html/_static/fonts/Lato-Bold.ttf b/docs/build/html/_static/fonts/Lato-Bold.ttf new file mode 100644 index 00000000..1d23c706 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato-Bold.ttf differ diff --git a/docs/build/html/_static/fonts/Lato-Regular.ttf b/docs/build/html/_static/fonts/Lato-Regular.ttf new file mode 100644 index 00000000..0f3d0f83 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato-Regular.ttf differ diff --git a/docs/build/html/_static/fonts/Lato/lato-bold.eot b/docs/build/html/_static/fonts/Lato/lato-bold.eot new file mode 100644 index 00000000..3361183a Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-bold.eot differ diff --git a/docs/build/html/_static/fonts/Lato/lato-bold.ttf b/docs/build/html/_static/fonts/Lato/lato-bold.ttf new file mode 100644 index 00000000..29f691d5 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-bold.ttf differ diff --git a/docs/build/html/_static/fonts/Lato/lato-bold.woff b/docs/build/html/_static/fonts/Lato/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-bold.woff differ diff --git a/docs/build/html/_static/fonts/Lato/lato-bold.woff2 b/docs/build/html/_static/fonts/Lato/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-bold.woff2 differ diff --git a/docs/build/html/_static/fonts/Lato/lato-bolditalic.eot b/docs/build/html/_static/fonts/Lato/lato-bolditalic.eot new file mode 100644 index 00000000..3d415493 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-bolditalic.eot differ diff --git a/docs/build/html/_static/fonts/Lato/lato-bolditalic.ttf b/docs/build/html/_static/fonts/Lato/lato-bolditalic.ttf new file mode 100644 index 00000000..f402040b Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-bolditalic.ttf differ diff --git a/docs/build/html/_static/fonts/Lato/lato-bolditalic.woff b/docs/build/html/_static/fonts/Lato/lato-bolditalic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-bolditalic.woff differ diff --git a/docs/build/html/_static/fonts/Lato/lato-bolditalic.woff2 b/docs/build/html/_static/fonts/Lato/lato-bolditalic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-bolditalic.woff2 differ diff --git a/docs/build/html/_static/fonts/Lato/lato-italic.eot b/docs/build/html/_static/fonts/Lato/lato-italic.eot new file mode 100644 index 00000000..3f826421 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-italic.eot differ diff --git a/docs/build/html/_static/fonts/Lato/lato-italic.ttf b/docs/build/html/_static/fonts/Lato/lato-italic.ttf new file mode 100644 index 00000000..b4bfc9b2 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-italic.ttf differ diff --git a/docs/build/html/_static/fonts/Lato/lato-italic.woff b/docs/build/html/_static/fonts/Lato/lato-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-italic.woff differ diff --git a/docs/build/html/_static/fonts/Lato/lato-italic.woff2 b/docs/build/html/_static/fonts/Lato/lato-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-italic.woff2 differ diff --git a/docs/build/html/_static/fonts/Lato/lato-regular.eot b/docs/build/html/_static/fonts/Lato/lato-regular.eot new file mode 100644 index 00000000..11e3f2a5 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-regular.eot differ diff --git a/docs/build/html/_static/fonts/Lato/lato-regular.ttf b/docs/build/html/_static/fonts/Lato/lato-regular.ttf new file mode 100644 index 00000000..74decd9e Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-regular.ttf differ diff --git a/docs/build/html/_static/fonts/Lato/lato-regular.woff b/docs/build/html/_static/fonts/Lato/lato-regular.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-regular.woff differ diff --git a/docs/build/html/_static/fonts/Lato/lato-regular.woff2 b/docs/build/html/_static/fonts/Lato/lato-regular.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-regular.woff2 differ diff --git a/docs/build/html/_static/fonts/RobotoSlab-Bold.ttf b/docs/build/html/_static/fonts/RobotoSlab-Bold.ttf new file mode 100644 index 00000000..df5d1df2 Binary files /dev/null and b/docs/build/html/_static/fonts/RobotoSlab-Bold.ttf differ diff --git a/docs/build/html/_static/fonts/RobotoSlab-Regular.ttf b/docs/build/html/_static/fonts/RobotoSlab-Regular.ttf new file mode 100644 index 00000000..eb52a790 Binary files /dev/null and b/docs/build/html/_static/fonts/RobotoSlab-Regular.ttf differ diff --git a/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot new file mode 100644 index 00000000..79dc8efe Binary files /dev/null and b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot differ diff --git a/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf new file mode 100644 index 00000000..df5d1df2 Binary files /dev/null and b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf differ diff --git a/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff differ diff --git a/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 differ diff --git a/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot new file mode 100644 index 00000000..2f7ca78a Binary files /dev/null and b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot differ diff --git a/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf new file mode 100644 index 00000000..eb52a790 Binary files /dev/null and b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf differ diff --git a/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff differ diff --git a/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 differ diff --git a/docs/build/html/_static/fonts/fontawesome-webfont.eot b/docs/build/html/_static/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/docs/build/html/_static/fonts/fontawesome-webfont.eot differ diff --git a/docs/build/html/_static/fonts/fontawesome-webfont.svg b/docs/build/html/_static/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/docs/build/html/_static/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/build/html/_static/fonts/fontawesome-webfont.ttf b/docs/build/html/_static/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/docs/build/html/_static/fonts/fontawesome-webfont.ttf differ diff --git a/docs/build/html/_static/fonts/fontawesome-webfont.woff b/docs/build/html/_static/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/docs/build/html/_static/fonts/fontawesome-webfont.woff differ diff --git a/docs/build/html/_static/fonts/fontawesome-webfont.woff2 b/docs/build/html/_static/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/docs/build/html/_static/fonts/fontawesome-webfont.woff2 differ diff --git a/docs/build/html/_static/jquery-3.5.1.js b/docs/build/html/_static/jquery-3.5.1.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/docs/build/html/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl add

+
+

Contents

+ +

Removes a project from workspace.

+

cpl add <source-project> <target-project>
+cpl a <source-project> <target-project>
+cpl A <source-project> <target-project>

+
+
+

Description

+

Adds a project reference to given project.

+

If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified.

+
+
+

Arguments

+ + + + + + + + + + + + + + + + + +

Argument

Description

Value type

<source-project>

Name of the project to which the reference has to be added

str

<target-project>

Name of the project to be referenced

str

+
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cli.build.html b/docs/build/html/cli.build.html new file mode 100644 index 00000000..bea2830b --- /dev/null +++ b/docs/build/html/cli.build.html @@ -0,0 +1,254 @@ + + + + + + + + + + cpl build — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl build

+
+

Contents

+ + +

Copies an python app into an output directory named build/ at the given output path. Must be executed within a CPL workspace or project directory

+

cpl build
+cpl b
+cpl B

+
+
+

Description

+

The command can be used to build a project of type “console” or “library”.

+

The build command copies all included source files to the output directory. You can run the source files in the output directory directly.

+

The command is used to prepare the source files for the publish command or to copy them to an target for execution.

+ +
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cli.generate.html b/docs/build/html/cli.generate.html new file mode 100644 index 00000000..1bcd64c9 --- /dev/null +++ b/docs/build/html/cli.generate.html @@ -0,0 +1,308 @@ + + + + + + + + + + cpl generate — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl generate

+
+

Contents

+ +

Generate a file based on schematic.

+

cpl generate <schematic> <name>
+cpl g <schematic> <name>
+cpl G <schematic> <name>

+
+
+

Description

+

Generates files based on a schematic.

+
+
+

Arguments

+ + + + + + + + + + + + + + + + + +

Argument

Description

Value type

<schematic>

The schematic to generate.

str

<name>

The name of the generated file.

str

+
+
+

Schematics

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Schematic

Description

Arguments

abc

Abstract base class

<name>

class

Class

<name>

enum

Enum class

<name>

service

Service class

<name>

settings

Configmodel

<name>

thread

Thread class

<name>

+
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cli.help.html b/docs/build/html/cli.help.html new file mode 100644 index 00000000..c9ffefdd --- /dev/null +++ b/docs/build/html/cli.help.html @@ -0,0 +1,261 @@ + + + + + + + + + + cpl help — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl help

+ + +

Lists available command and their short descriptions.

+

cpl help <command>
+cpl h <command>
+cpl H <command>

+
+

Description

+

Lists available command and their short descriptions.

+
+
+

Arguments

+ + + + + + + + + + + + + +

Argument

Description

Value type

<command>

Shows a help message for this command in the console.

str

+
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cli.install.html b/docs/build/html/cli.install.html new file mode 100644 index 00000000..4a9223a7 --- /dev/null +++ b/docs/build/html/cli.install.html @@ -0,0 +1,266 @@ + + + + + + + + + + cpl install — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl install

+
+

Contents

+ +

Installs given package via pip

+

cpl install <package>
+cpl i <package>
+cpl I <package>

+
+
+

Description

+

Install given package to project via pip. +Without given package it will install the depedencies of the CPL project your in.

+
+
+

Arguments

+ + + + + + + + + + + + + +

Argument

Description

Value type

<package>

The package to install

str

+
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cli.new.html b/docs/build/html/cli.new.html new file mode 100644 index 00000000..6fd822a3 --- /dev/null +++ b/docs/build/html/cli.new.html @@ -0,0 +1,286 @@ + + + + + + + + + + cpl new — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl new

+
+

Contents

+ +

Generates a workspace and initial project or add a project to workspace.

+

cpl new <type> <name>
+cpl n <type> <name>
+cpl N <type> <name>

+
+
+

Description

+

Generates a workspace and initial project or add a project to workspace.

+

If the command is running in a CPL workspace, it will add the new project to the workspace.

+ + + + + + + + + + + + + + + + + +

Argument

Description

Value type

<type>

The type of the project, see types

str

<name>

The name of the project

str

+
+
+

Project types

+ + + + + + + + + + + + + + +

Project type

Description

console

A simple console application

library

A package

+
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cli.overview.html b/docs/build/html/cli.overview.html new file mode 100644 index 00000000..ecb1e767 --- /dev/null +++ b/docs/build/html/cli.overview.html @@ -0,0 +1,335 @@ + + + + + + + + + + CLI Overview and Command Reference — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

CLI Overview and Command Reference

+ +
+

Basic workflow

+

To create, build, and serve a new, basic CPL project on a development server, go to the parent directory of your new workspace use the following commands:

+
cpl new console my-first-project
+cd my-first-project
+cpl start
+
+
+

In the terminal you will the output of the app.

+
+
+

CLI command-language syntax

+

cpl commandNameOrAlias requiredArg [optionalsArgs]

+
    +

  • Most commands, and some options, have aliases. Aliases are shown in the syntax statement for each command.

    • +

  • Arguments are not prefixed.

    • +
+
+

Relative paths

+

Options that specify files can be given as absolute paths, or as paths relative to the current working directory, which is generally either the workspace or project root.

+
+
+

Schematics

+

The cpl generate command takes as an argument the artifact to be generated. In addition to any general options, each artifact defines its own options in a schematic. Schematic options are supplied to the command in the same format as immediate command options.

+
+
+
+

Command overview

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Command

Alias

Description

add

a or a

Adds a project reference to given project.

build

b or B

Prepares files for publish into an output directory named dist/ at the given output path. Must be executed from within a workspace directory.

generate

g or G

Generate a new file.

help

h or H

Lists available command and their short descriptions.

install

i or I

With argument installs packages to project, without argument installs project dependencies.

new

n or N

Creates new CPL project.

publish

p or P

Prepares files for publish into an output directory named dist/ at the given output path and executes setup.py. Must be executed from within a library workspace directory.

remove

r or R

Removes a project from workspace.

start

s or S

Starts CPL project, restarting on file changes.

uninstall

ui or UI

Uninstalls packages from project.

update

u or U

Update CPL and project dependencies.

version

v or V

Outputs CPL CLI version.

+
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cli.publish.html b/docs/build/html/cli.publish.html new file mode 100644 index 00000000..d7a95a60 --- /dev/null +++ b/docs/build/html/cli.publish.html @@ -0,0 +1,254 @@ + + + + + + + + + + cpl publish — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl publish

+
+

Contents

+ + +

Prepares files for publish into an output directory named dist/ at the given output path and executes setup.py.

+

cpl publish
+cpl p
+cpl P

+
+
+

Description

+

The command can be used to publish a project of type “console” or “library”.

+

The publish command builds the source files and then creates an setup.py with data from cpl.json. +The command executes the setup.py and removes all source files with the setup.py from the ‘publish/’ directory.

+

Generated files of setup.py are in the ‘publish/setup/’ directory.

+
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cli.remove.html b/docs/build/html/cli.remove.html new file mode 100644 index 00000000..dae705d9 --- /dev/null +++ b/docs/build/html/cli.remove.html @@ -0,0 +1,268 @@ + + + + + + + + + + cpl remove — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl remove

+
+

Contents

+ +

Removes a project from workspace.

+

cpl remove <project>
+cpl r <project>
+cpl R <project>

+
+
+

Description

+

The command can be used to publish a project of type “console” or “library”.

+

The publish command builds the source files and then creates an setup.py with data from cpl.json. +The command executes the setup.py and removes all source files with the setup.py from the ‘publish/’ directory.

+

Generated files of setup.py are in the ‘publish/setup/’ directory.

+
+
+

Arguments

+ + + + + + + + + + + + + +

Argument

Description

Value type

<project>

The name of the project to delete

str

+
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cli.start.html b/docs/build/html/cli.start.html new file mode 100644 index 00000000..8878bd6d --- /dev/null +++ b/docs/build/html/cli.start.html @@ -0,0 +1,232 @@ + + + + + + + + + + cpl start — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl start

+

Starts your application, restarting on file changes.

+

cpl start
+cpl s
+cpl S

+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cli.uninstall.html b/docs/build/html/cli.uninstall.html new file mode 100644 index 00000000..dd3b9b6c --- /dev/null +++ b/docs/build/html/cli.uninstall.html @@ -0,0 +1,265 @@ + + + + + + + + + + cpl uninstall — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl uninstall

+
+

Contents

+ +

Uninstalls given package via pip

+

cpl uninstall <package>
+cpl ui <package>
+cpl UI <package>

+
+
+

Description

+

Uninstall given package from project via pip.

+
+
+

Arguments

+ + + + + + + + + + + + + +

Argument

Description

Value type

<package>

The package to uninstall

str

+
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cli.update.html b/docs/build/html/cli.update.html new file mode 100644 index 00000000..cefd77a3 --- /dev/null +++ b/docs/build/html/cli.update.html @@ -0,0 +1,232 @@ + + + + + + + + + + cpl update — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl update

+

Updates the CPL and project dependencies.

+

cpl update
+cpl u
+cpl U

+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cli.version.html b/docs/build/html/cli.version.html new file mode 100644 index 00000000..ea20b166 --- /dev/null +++ b/docs/build/html/cli.version.html @@ -0,0 +1,230 @@ + + + + + + + + + + cpl version — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl version

+

Lists the version of CPL, CPL CLI and all installed packages from pip.

+

cpl version
+cpl v
+cpl V

+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/contributing.html b/docs/build/html/contributing.html new file mode 100644 index 00000000..2f2c6886 --- /dev/null +++ b/docs/build/html/contributing.html @@ -0,0 +1,298 @@ + + + + + + + + + + Contributing to CPL — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Contributing to CPL

+

We would love for you to contribute to CPL and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:

+ +
+

Found a Bug?

+

If you find a bug in the source code, you can help us by submitting an issue to our Gitea Repository. Even better, you can submit a Pull Request with a fix.

+
+
+

Feature Request

+

You can request a new feature by submitting an issue to our Gitea Repository. If you would like to implement a new feature, please consider the size of the change in order to determine the right steps to proceed:

+

For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.

+

Note: Adding a new topic to the documentation, or significantly re-writing a topic, counts as a major feature.

+

Small Features can be crafted and directly submitted as a Pull Request.

+
+
+

Submission Guidelines

+
+

Submitting an Issue

+

Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.

+

We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we require that you provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions.

+

A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem.

+

We require a minimal reproduction to save maintainers’ time and ultimately be able to fix more bugs. Often, developers find coding problems themselves while preparing a minimal reproduction. We understand that sometimes it might be hard to extract essential bits of code from a larger codebase but we really need to isolate the problem before we can fix it.

+

Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don’t hear back from you, we are going to close an issue that doesn’t have enough info to be reproduced.

+
+
+

Submitting a Pull Request

+

Before you submit your Pull Request (PR) consider the following guidelines:

+
    +

  1. Search the repository for an open or closed PR that relates to your submission. You don’t want to duplicate existing efforts.

    2. +

  2. Be sure that an issue describes the problem you’re fixing, or documents the design for the feature you’d like to add. Discussing the design upfront helps to ensure that we’re ready to accept your work.

    3. +

  3. Fork the sh-edraft.de/sh_cpl repo.

    4. +

  4. In your forked repository, make your changes in a new git branch:

    +
    git checkout -b my-fix-branch master
+
    +
    +
    5. +

  5. Create your patch, including appropriate test cases.

    6. +
+ +
    +

  1. Commit your changes.

    +
    git commit --all
+
    +
    +

    Note: the optional commit -a command line option will automatically “add” and “rm” edited files.

    +
    2. +

  2. Push your branch to the repository:

    +
    git push origin my-fix-branch
+
    +
    +
    3. +

  3. In Gitea, send a pull request to sh_cpl:master

    4. +
+
+
+

Reviewing a Pull Request

+

The sh-edraft.de team reserves the right not to accept pull requests from community members who haven’t been good citizens of the community. Such behavior includes not following the CPL coding rules and applies within or outside of CPL managed channels.

+
+

Addressing review feedback

+

If we ask for changes via code reviews then:

+
    +

  1. Make the required updates to the code.

    2. +

  2. Create a fixup commit and push to your repository (this will update your Pull Request):

    +
    git commit --all --fixup HEAD
+git push
+
    +
    +
    3. +
+

That’s it! Thank you for your contribution!

+
+
+
+
+

Coding Rules

+

To ensure consistency throughout the source code, keep these rules in mind as you are working:

+ +
+
+

License

+

By contributing, you agree that your contributions will be licensed under its MIT License. +See LICENSE

+ +
+
+ + +
+ +
+
+ +
+ +
+

+ © Copyright 2021, Sven Heidemann. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cpl.application.html b/docs/build/html/cpl.application.html new file mode 100644 index 00000000..f3a9acc6 --- /dev/null +++ b/docs/build/html/cpl.application.html @@ -0,0 +1,366 @@ + + + + + + + + + + cpl.application — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl.application

+
+

cpl.application.application_abc

+
+
+class cpl.application.application_abc.ApplicationABC(config: cpl.configuration.configuration_abc.ConfigurationABC, services: cpl.dependency_injection.service_provider_abc.ServiceProviderABC)
+

Bases: abc.ABC

+

ABC for the Application class

+
+
+
config: cpl.configuration.configuration_abc.ConfigurationABC

Contains object loaded from appsettings

+
+
services: cpl.dependency_injection.service_provider_abc.ServiceProviderABC

Contains instances of prepared objects

+
+
+
+
+
+abstract configure()
+

Configure the application

+

Called by cpl.application.application_abc.ApplicationABC.run

+
+ +
+
+abstract main()
+

Custom entry point

+

Called by cpl.application.application_abc.ApplicationABC.run

+
+ +
+
+run()
+

Entry point

+

Called by custom Application.main

+
+ +
+ +
+
+

cpl.application.application_builder

+
+
+class cpl.application.application_builder.ApplicationBuilder(app: Type[cpl.application.application_abc.ApplicationABC])
+

Bases: cpl.application.application_builder_abc.ApplicationBuilderABC

+

This is class is used to build a object of cpl.application.application_abc.ApplicationABC

+
+
+
app: Type[cpl.application.application_abc.ApplicationABC]

Application to build

+
+
+
+
+
+build() → cpl.application.application_abc.ApplicationABC
+

Creates custom application object

+
+
+
+ +
+
+use_startup(startup: Type[cpl.application.startup_abc.StartupABC])
+

Sets the custom startup class to use

+
+
+
startup: Type[cpl.application.startup_abc.StartupABC]

Startup class to use

+
+
+
+
+ +
+ +
+
+

cpl.application.application_builder_abc

+
+
+class cpl.application.application_builder_abc.ApplicationBuilderABC(*args)
+

Bases: abc.ABC

+

ABC for the cpl.application.application_builder.ApplicationBuilder

+
+
+abstract build() → cpl.application.application_abc.ApplicationABC
+

Creates custom application object

+
+
+
+ +
+
+abstract use_startup(startup: Type[cpl.application.startup_abc.StartupABC])
+

Sets the custom startup class to use

+
+
+
startup: Type[cpl.application.startup_abc.StartupABC]

Startup class to use

+
+
+
+
+ +
+ +
+
+

cpl.application.startup_abc

+
+
+class cpl.application.startup_abc.StartupABC(*args)
+

Bases: abc.ABC

+

ABC for the startup class

+
+
+abstract configure_configuration() → cpl.configuration.configuration_abc.ConfigurationABC
+

Creates configuration of application

+
+
+
+ +
+
+abstract configure_services() → cpl.dependency_injection.service_provider_abc.ServiceProviderABC
+

Creates service provider

+
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cpl.configuration.html b/docs/build/html/cpl.configuration.html new file mode 100644 index 00000000..160e1877 --- /dev/null +++ b/docs/build/html/cpl.configuration.html @@ -0,0 +1,533 @@ + + + + + + + + + + cpl.configuration — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl.configuration

+
+

cpl.configuration.configuration

+
+
+class cpl.configuration.configuration.Configuration
+

Bases: cpl.configuration.configuration_abc.ConfigurationABC

+
+
+add_configuration(key_type: Union[str, type], value: cpl.configuration.configuration_model_abc.ConfigurationModelABC)
+

Add configuration object

+
+
+
key_type: Union[str, type]

Type of the value

+
+
value: cpl.configuration.configuration_model_abc.ConfigurationModelABC

Object of the value

+
+
+
+
+ +
+
+add_console_argument(argument: cpl.configuration.console_argument.ConsoleArgument)
+

Adds console argument to known console arguments

+
+
+
argument: cpl.configuration.console_argument.ConsoleArgument

Specifies the console argument

+
+
+
+
+ +
+
+add_console_arguments(error: Optional[bool] = None)
+

Reads the console arguments

+
+
+
error: bool

Defines is invalid argument error will be shown or not

+
+
+
+
+ +
+
+add_environment_variables(prefix: str)
+

Reads the environment variables

+
+
+
prefix: str

Prefix of the variables

+
+
+
+
+ +
+
+add_json_file(name: str, optional: Optional[bool] = None, output: bool = True, path: Optional[str] = None)
+

Reads and saves settings from given json file

+
+
+
name: str

Name of the file

+
+
optional: str

Specifies whether an error should occur if the file was not found

+
+
output: bool

Specifies whether an output should take place

+
+
path: str

Path in which the file should be stored

+
+
+
+
+ +
+
+property additional_arguments
+
+ +
+
+property argument_error_function
+
+ +
+
+property environment
+
+ +
+
+get_configuration(search_type: Union[str, Type[cpl.configuration.configuration_model_abc.ConfigurationModelABC]]) → Union[str, collections.abc.Callable[cpl.configuration.configuration_model_abc.ConfigurationModelABC]]
+

Returns value from configuration by given type

+
+
+
search_type: Union[str, Type[cpl.configuration.configuration_model_abc.ConfigurationModelABC]]

Type to search for

+
+
+
+
+
+
+ +
+ +
+
+

cpl.configuration.configuration_abc

+
+
+class cpl.configuration.configuration_abc.ConfigurationABC
+

Bases: abc.ABC

+
+
+abstract add_configuration(key_type: Union[str, type], value: cpl.configuration.configuration_model_abc.ConfigurationModelABC)
+

Add configuration object

+
+
+
key_type: Union[str, type]

Type of the value

+
+
value: cpl.configuration.configuration_model_abc.ConfigurationModelABC

Object of the value

+
+
+
+
+ +
+
+abstract add_console_argument(argument: cpl.configuration.console_argument.ConsoleArgument)
+

Adds console argument to known console arguments

+
+
+
argument: cpl.configuration.console_argument.ConsoleArgument

Specifies the console argument

+
+
+
+
+ +
+
+abstract add_console_arguments(error: Optional[bool] = None)
+

Reads the console arguments

+
+
+
error: bool

Defines is invalid argument error will be shown or not

+
+
+
+
+ +
+
+abstract add_environment_variables(prefix: str)
+

Reads the environment variables

+
+
+
prefix: str

Prefix of the variables

+
+
+
+
+ +
+
+abstract add_json_file(name: str, optional: Optional[bool] = None, output: bool = True, path: Optional[str] = None)
+

Reads and saves settings from given json file

+
+
+
name: str

Name of the file

+
+
optional: str

Specifies whether an error should occur if the file was not found

+
+
output: bool

Specifies whether an output should take place

+
+
path: str

Path in which the file should be stored

+
+
+
+
+ +
+
+abstract property additional_arguments
+
+ +
+
+abstract property argument_error_function
+
+ +
+
+abstract property environment
+
+ +
+
+abstract get_configuration(search_type: Union[str, Type[cpl.configuration.configuration_model_abc.ConfigurationModelABC]]) → Union[str, collections.abc.Callable[cpl.configuration.configuration_model_abc.ConfigurationModelABC]]
+

Returns value from configuration by given type

+
+
+
search_type: Union[str, Type[cpl.configuration.configuration_model_abc.ConfigurationModelABC]]

Type to search for

+
+
+
+
+
+
+ +
+ +
+
+

cpl.configuration.configuration_model_abc

+
+
+class cpl.configuration.configuration_model_abc.ConfigurationModelABC
+

Bases: abc.ABC

+
+
+abstract from_dict(settings: dict)
+

Converts attributes to dict

+
+

settings: dict

+
+
+ +
+ +
+
+

cpl.configuration.configuration_variable_name_enum

+
+
+class cpl.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum(value)
+

Bases: enum.Enum

+

An enumeration.

+
+
+customer = 'CUSTOMER'
+
+ +
+
+environment = 'ENVIRONMENT'
+
+ +
+
+name = 'NAME'
+
+ +
+
+static to_list()
+
+ +
+ +
+
+

cpl.configuration.console_argument

+
+
+class cpl.configuration.console_argument.ConsoleArgument(token: str, name: str, aliases: list, value_token: str, is_value_token_optional: Optional[bool] = None, console_arguments: Optional[list] = None)
+

Bases: object

+
+
+property aliases
+
+ +
+
+property console_arguments
+
+ +
+
+property is_value_token_optional
+
+ +
+
+property name
+
+ +
+
+property token
+
+ +
+
+property value_token
+
+ +
+ +
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cpl.console.html b/docs/build/html/cpl.console.html new file mode 100644 index 00000000..1c15762f --- /dev/null +++ b/docs/build/html/cpl.console.html @@ -0,0 +1,695 @@ + + + + + + + + + + cpl.console — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl.console

+
+

cpl.console.background_color_enum

+
+
+class cpl.console.background_color_enum.BackgroundColorEnum(value)
+

Bases: enum.Enum

+

An enumeration.

+
+
+blue = 'on_blue'
+
+ +
+
+cyan = 'on_cyan'
+
+ +
+
+default = 'on_default'
+
+ +
+
+green = 'on_green'
+
+ +
+
+grey = 'on_grey'
+
+ +
+
+magenta = 'on_magenta'
+
+ +
+
+red = 'on_red'
+
+ +
+
+white = 'on_white'
+
+ +
+
+yellow = 'on_yellow'
+
+ +
+ +
+
+

cpl.console.console

+
+
+class cpl.console.console.Console
+

Bases: object

+

Useful functions for handling with input and output

+
+
+background_color = 'on_default'
+
+ +
+
+classmethod banner(string: str)
+

Prints the string as a banner

+
+
+
string: str

Message to print as banner

+
+
+
+
+ +
+
+classmethod clear()
+

Clears the console

+
+ +
+
+classmethod close()
+

Closes the application

+
+ +
+
+classmethod color_reset()
+

Resets the color settings

+
+ +
+
+classmethod disable()
+

Disables console interaction

+
+ +
+
+classmethod enable()
+

Enables console interaction

+
+ +
+
+classmethod error(string: str, tb: Optional[str] = None)
+

Prints an error with traceback

+
+
+
string: str

Error message

+
+
tb: str

Error traceback

+
+
+
+
+ +
+
+foreground_color = 'default'
+
+ +
+
+classmethod read(output: Optional[str] = None) → str
+

Reads in line

+
+
+
output: str

String to print before input

+
+
+
+
+

input()

+
+
+ +
+
+classmethod read_line(output: Optional[str] = None) → str
+

Reads in next line

+
+
+
output: str

String to print before input

+
+
+
+
+

input()

+
+
+ +
+
+classmethod reset_cursor_position()
+

Resets cursor position

+
+ +
+
+classmethod select(char: str, message: str, options: list, header_foreground_color: Union[str, cpl.console.foreground_color_enum.ForegroundColorEnum] = <ForegroundColorEnum.default: 'default'>, header_background_color: Union[str, cpl.console.background_color_enum.BackgroundColorEnum] = <BackgroundColorEnum.default: 'on_default'>, option_foreground_color: Union[str, cpl.console.foreground_color_enum.ForegroundColorEnum] = <ForegroundColorEnum.default: 'default'>, option_background_color: Union[str, cpl.console.background_color_enum.BackgroundColorEnum] = <BackgroundColorEnum.default: 'on_default'>, cursor_foreground_color: Union[str, cpl.console.foreground_color_enum.ForegroundColorEnum] = <ForegroundColorEnum.default: 'default'>, cursor_background_color: Union[str, cpl.console.background_color_enum.BackgroundColorEnum] = <BackgroundColorEnum.default: 'on_default'>) → str
+

Prints select menu

+
+
+
char: str

Character to show which element is selected

+
+
message: str

Message or header of the selection

+
+
options: List[str]

Selectable options

+
+
header_foreground_color: Union[str, cpl.console.foreground_color_enum.ForegroundColorEnum]

Foreground color of the header

+
+
header_background_color: Union[str, cpl.console.background_color_enum.BackgroundColorEnum]

Background color of the header

+
+
option_foreground_color: Union[str, cpl.console.foreground_color_enum.ForegroundColorEnum]

Foreground color of the options

+
+
option_background_color: Union[str, cpl.console.background_color_enum.BackgroundColorEnum]

Background color of the options

+
+
cursor_foreground_color: Union[str, cpl.console.foreground_color_enum.ForegroundColorEnum]

Foreground color of the cursor

+
+
cursor_background_color: Union[str, cpl.console.background_color_enum.BackgroundColorEnum]

Background color of the cursor

+
+
+
+
+

Selected option as str

+
+
+ +
+
+classmethod set_background_color(color: Union[cpl.console.background_color_enum.BackgroundColorEnum, str])
+

Sets the background color

+
+
+
color: Union[cpl.console.background_color_enum.BackgroundColorEnum, str]

Background color of the console

+
+
+
+
+ +
+
+classmethod set_cursor_position(x: int, y: int)
+

Sets cursor position

+
+
+
x: int

X coordinate

+
+
y: int

Y coordinate

+
+
+
+
+ +
+
+classmethod set_foreground_color(color: Union[cpl.console.foreground_color_enum.ForegroundColorEnum, str])
+

Sets the foreground color

+
+
+
color: Union[cpl.console.background_color_enum.BackgroundColorEnum, str]

Foreground color of the console

+
+
+
+
+ +
+
+classmethod set_hold_back(value: bool)
+
+ +
+
+classmethod spinner(message: str, call: collections.abc.Callable, *args, text_foreground_color: Optional[Union[str, cpl.console.foreground_color_enum.ForegroundColorEnum]] = None, spinner_foreground_color: Optional[Union[str, cpl.console.foreground_color_enum.ForegroundColorEnum]] = None, text_background_color: Optional[Union[str, cpl.console.background_color_enum.BackgroundColorEnum]] = None, spinner_background_color: Optional[Union[str, cpl.console.background_color_enum.BackgroundColorEnum]] = None, **kwargs) → any
+

Shows spinner and calls given function, when function has ended the spinner stops

+
+
+
message: str

Message of the spinner

+
+
call: Callable

Function to call

+
+
args: list

Arguments of the function

+
+
text_foreground_color: Union[str, cpl.console.foreground_color_enum.ForegroundColorEnum]

Foreground color of the text

+
+
spinner_foreground_color: Union[str, cpl.console.foreground_color_enum.ForegroundColorEnum]

Foreground color of the spinner

+
+
text_background_color: Union[str, cpl.console.background_color_enum.BackgroundColorEnum]

Background color of the text

+
+
spinner_background_color: Union[str, cpl.console.background_color_enum.BackgroundColorEnum]

Background color of the spinner

+
+
kwargs: dict

Keyword arguments of the call

+
+
+
+
+

Return value of call

+
+
+ +
+
+classmethod table(header: list, values: list)
+

Prints a table with header and values

+
+
+
header: List[str]

Header of the table

+
+
values: List[List[str]]

Values of the table

+
+
+
+
+ +
+
+classmethod write(*args, end='')
+

Prints in active line

+
+
+
args: list

Elements to print

+
+
end: str

Last character to print

+
+
+
+
+ +
+
+classmethod write_at(x: int, y: int, *args)
+

Prints at given position

+
+
+
x: int

X coordinate

+
+
y: int

Y coordinate

+
+
args: list

Elements to print

+
+
+
+
+ +
+
+classmethod write_line(*args)
+

Prints to new line

+
+
+
args: list

Elements to print

+
+
+
+
+ +
+
+classmethod write_line_at(x: int, y: int, *args)
+

Prints new line at given position

+
+
+
x: int

X coordinate

+
+
y: int

Y coordinate

+
+
args: list

Elements to print

+
+
+
+
+ +
+ +
+
+

cpl.console.console_call

+
+
+class cpl.console.console_call.ConsoleCall(function: collections.abc.Callable, *args)
+

Bases: object

+

Represents a console call, for hold back when spinner is active

+
+
+
function: Callable

Function to call

+
+
args: list

List of arguments

+
+
+
+
+
+property args
+
+ +
+
+property function
+
+ +
+ +
+
+

cpl.console.foreground_color_enum

+
+
+class cpl.console.foreground_color_enum.ForegroundColorEnum(value)
+

Bases: enum.Enum

+

An enumeration.

+
+
+blue = 'blue'
+
+ +
+
+cyan = 'cyan'
+
+ +
+
+default = 'default'
+
+ +
+
+green = 'green'
+
+ +
+
+grey = 'grey'
+
+ +
+
+magenta = 'magenta'
+
+ +
+
+red = 'red'
+
+ +
+
+white = 'white'
+
+ +
+
+yellow = 'yellow'
+
+ +
+ +
+
+

cpl.console.spinner_thread

+
+
+class cpl.console.spinner_thread.SpinnerThread(msg_len: int, foreground_color: cpl.console.foreground_color_enum.ForegroundColorEnum, background_color: cpl.console.background_color_enum.BackgroundColorEnum)
+

Bases: threading.Thread

+

Thread to show spinner in terminal

+
+
+
msg_len: int

Length of the message

+
+
foreground_color: cpl.console.foreground_color.ForegroundColorEnum

Foreground color of the spinner

+
+
background_color: cpl.console.background_color.BackgroundColorEnum

Background color of the spinner

+
+
+
+
+
+exit()
+

Stops the spinner

+
+ +
+
+run() → None
+

Entry point of thread, shows the spinner

+
+ +
+
+stop_spinning()
+

Stops the spinner

+
+ +
+ +
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cpl.database.connection.html b/docs/build/html/cpl.database.connection.html new file mode 100644 index 00000000..5fe1a33c --- /dev/null +++ b/docs/build/html/cpl.database.connection.html @@ -0,0 +1,306 @@ + + + + + + + + + + cpl.database.connection — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl.database.connection

+
+

cpl.database.connection.database_connection

+
+
+class cpl.database.connection.database_connection.DatabaseConnection(database_settings: cpl.database.database_settings.DatabaseSettings)
+

Bases: cpl.database.connection.database_connection_abc.DatabaseConnectionABC

+

Representation of the database connection

+
+
+
+
+connect(connection_string: str)
+

Connects to a database by connection string

+
+
+
connection_string: str

Database connection string, see: https://docs.sqlalchemy.org/en/14/core/engines.html

+
+
+
+
+ +
+
+property engine
+
+ +
+
+property session
+
+ +
+ +
+
+

cpl.database.connection.database_connection_abc

+
+
+class cpl.database.connection.database_connection_abc.DatabaseConnectionABC
+

Bases: abc.ABC

+

ABC for the cpl.database.connection.database_connection.DatabaseConnection

+
+
+abstract connect(connection_string: str)
+

Connects to a database by connection string

+
+
+
connection_string: str

Database connection string, see: https://docs.sqlalchemy.org/en/14/core/engines.html

+
+
+
+
+ +
+
+abstract property engine
+
+ +
+
+abstract property session
+
+ +
+ +
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cpl.database.context.html b/docs/build/html/cpl.database.context.html new file mode 100644 index 00000000..9ddef1c0 --- /dev/null +++ b/docs/build/html/cpl.database.context.html @@ -0,0 +1,318 @@ + + + + + + + + + + cpl.database.context — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl.database.context

+
+

cpl.database.context.database_context

+
+
+class cpl.database.context.database_context.DatabaseContext(database_settings: cpl.database.database_settings.DatabaseSettings)
+

Bases: cpl.database.context.database_context_abc.DatabaseContextABC

+

Representation of the database context

+
+
+
+
+connect(connection_string: str)
+

Connects to a database by connection string

+
+
+
connection_string: str

Database connection string, see: https://docs.sqlalchemy.org/en/14/core/engines.html

+
+
+
+
+ +
+
+property engine
+
+ +
+
+save_changes()
+

Saves changes of the database

+
+ +
+
+property session
+
+ +
+ +
+
+

cpl.database.context.database_context_abc

+
+
+class cpl.database.context.database_context_abc.DatabaseContextABC(*args)
+

Bases: abc.ABC

+

ABC for the cpl.database.context.database_context.DatabaseContext

+
+
+abstract connect(connection_string: str)
+

Connects to a database by connection string

+
+
+
connection_string: str

Database connection string, see: https://docs.sqlalchemy.org/en/14/core/engines.html

+
+
+
+
+ +
+
+abstract property engine
+
+ +
+
+save_changes()
+

Saves changes of the database

+
+ +
+
+abstract property session
+
+ +
+ +
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cpl.database.html b/docs/build/html/cpl.database.html new file mode 100644 index 00000000..0cd287bf --- /dev/null +++ b/docs/build/html/cpl.database.html @@ -0,0 +1,340 @@ + + + + + + + + + + cpl.database — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl.database

+
+ +
+
+

Submodules

+
+
+

cpl.database.database_model

+
+
+

cpl.database.database_settings

+
+
+class cpl.database.database_settings.DatabaseSettings
+

Bases: cpl.configuration.configuration_model_abc.ConfigurationModelABC

+

Represents settings for the database connection

+
+
+property auth_plugin
+
+ +
+
+property case_sensitive
+
+ +
+
+property connection_string
+
+ +
+
+property credentials
+
+ +
+
+property echo
+
+ +
+
+property encoding
+
+ +
+
+from_dict(settings: dict)
+

Sets attributes from given dict

+

settings: dict

+
+ +
+ +
+
+

cpl.database.database_settings_name_enum

+
+
+class cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum(value)
+

Bases: enum.Enum

+

An enumeration.

+
+
+auth_plugin = 'AuthPlugin'
+
+ +
+
+case_sensitive = 'CaseSensitive'
+
+ +
+
+connection_string = 'ConnectionString'
+
+ +
+
+credentials = 'Credentials'
+
+ +
+
+echo = 'Echo'
+
+ +
+
+encoding = 'Encoding'
+
+ +
+ +
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cpl.dependency_injection.html b/docs/build/html/cpl.dependency_injection.html new file mode 100644 index 00000000..b6759da7 --- /dev/null +++ b/docs/build/html/cpl.dependency_injection.html @@ -0,0 +1,543 @@ + + + + + + + + + + cpl.dependency_injection — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl.dependency_injection

+
+

cpl.dependency_injection.service_collection

+
+
+class cpl.dependency_injection.service_collection.ServiceCollection(config: cpl.configuration.configuration_abc.ConfigurationABC)
+

Bases: cpl.dependency_injection.service_collection_abc.ServiceCollectionABC

+

Representation of the collection of services

+
+
+add_db_context(db_context_type: Type[cpl.database.context.database_context_abc.DatabaseContextABC], db_settings: cpl.database.database_settings.DatabaseSettings)
+

Adds database context

+
+
+
db_context: Type[cpl.database.context.database_context_abc.DatabaseContextABC]

Database context

+
+
db_settings: cpl.database.database_settings.DatabaseSettings

Database settings

+
+
+
+
+ +
+
+add_logging()
+

Adds the CPL internal logger

+
+ +
+
+add_scoped(service_type: Type, service: Optional[Callable] = None)
+

Adds a service with scoped lifetime

+
+
+
service_type: Type

Type of the service

+
+
service: Callable

Object of the service

+
+
+
+
+ +
+
+add_singleton(service_type: Union[type, object], service: Optional[Union[type, object]] = None)
+

Adds a service with singleton lifetime

+
+
+
service_type: Type

Type of the service

+
+
service: Callable

Object of the service

+
+
+
+
+ +
+
+add_transient(service_type: type, service: Optional[type] = None)
+

Adds a service with transient lifetime

+
+
+
service_type: Type

Type of the service

+
+
service: Callable

Object of the service

+
+
+
+
+ +
+
+build_service_provider() → cpl.dependency_injection.service_provider_abc.ServiceProviderABC
+

Creates instance of the service provider

+
+
+
+ +
+ +
+
+

cpl.dependency_injection.service_collection_abc

+
+
+class cpl.dependency_injection.service_collection_abc.ServiceCollectionABC
+

Bases: abc.ABC

+

ABC for the class cpl.dependency_injection.service_collection.ServiceCollection

+
+
+abstract add_db_context(db_context: Type[cpl.database.context.database_context_abc.DatabaseContextABC], db_settings: cpl.database.database_settings.DatabaseSettings)
+

Adds database context

+
+
+
db_context: Type[cpl.database.context.database_context_abc.DatabaseContextABC]

Database context

+
+
db_settings: cpl.database.database_settings.DatabaseSettings

Database settings

+
+
+
+
+ +
+
+abstract add_logging()
+

Adds the CPL internal logger

+
+ +
+
+abstract add_scoped(service_type: Type, service: Optional[collections.abc.Callable] = None)
+

Adds a service with scoped lifetime

+
+
+
service_type: Type

Type of the service

+
+
service: Callable

Object of the service

+
+
+
+
+ +
+
+abstract add_singleton(service_type: Type, service: Optional[collections.abc.Callable] = None)
+

Adds a service with singleton lifetime

+
+
+
service_type: Type

Type of the service

+
+
service: Callable

Object of the service

+
+
+
+
+ +
+
+abstract add_transient(service_type: Type, service: Optional[collections.abc.Callable] = None)
+

Adds a service with transient lifetime

+
+
+
service_type: Type

Type of the service

+
+
service: Callable

Object of the service

+
+
+
+
+ +
+
+abstract build_service_provider() → cpl.dependency_injection.service_provider_abc.ServiceProviderABC
+

Creates instance of the service provider

+
+
+
+ +
+ +
+
+

cpl.dependency_injection.service_descriptor

+
+
+class cpl.dependency_injection.service_descriptor.ServiceDescriptor(implementation: Optional[Union[type, object]], lifetime: cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum)
+

Bases: object

+

Descriptor of a service

+
+
+
implementation: Union[type, Optional[object]]

Object or type of service

+
+
lifetime: cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum

Lifetime of the service

+
+
+
+
+
+property implementation
+
+ +
+
+property lifetime
+
+ +
+
+property service_type
+
+ +
+ +
+
+

cpl.dependency_injection.service_lifetime_enum

+
+
+class cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum(value)
+

Bases: enum.Enum

+

An enumeration.

+
+
+scoped = 1
+
+ +
+
+singleton = 0
+
+ +
+
+transient = 2
+
+ +
+ +
+
+

cpl.dependency_injection.service_provider

+
+
+class cpl.dependency_injection.service_provider.ServiceProvider(service_descriptors: list, config: cpl.configuration.configuration_abc.ConfigurationABC, db_context: Optional[cpl.database.context.database_context_abc.DatabaseContextABC])
+

Bases: cpl.dependency_injection.service_provider_abc.ServiceProviderABC

+

Provider for the services

+
+
+
service_descriptors: list[cpl.dependency_injection.service_descriptor.ServiceDescriptor]

Descriptor of the service

+
+
config: cpl.configuration.configuration_abc.ConfigurationABC

CPL Configuration

+
+
db_context: Optional[cpl.database.context.database_context_abc.DatabaseContextABC]

Database representation

+
+
+
+
+
+build_service(service_type: type) → object
+

Creates instance of given type

+
+
+
instance_type: Type

The type of the searched instance

+
+
+
+
+

Object of the given type

+
+
+ +
+
+get_service(service_type: type) → Optional[collections.abc.Callable[object]]
+

Returns instance of given type

+
+
+
instance_type: Type

The type of the searched instance

+
+
+
+
+

Object of type Optional[Callable[object]]

+
+
+ +
+ +
+
+

cpl.dependency_injection.service_provider_abc

+
+
+class cpl.dependency_injection.service_provider_abc.ServiceProviderABC
+

Bases: abc.ABC

+

ABC for the class cpl.dependency_injection.service_provider.ServiceProvider

+
+
+abstract build_service(service_type: Type) → object
+

Creates instance of given type

+
+
+
instance_type: Type

The type of the searched instance

+
+
+
+
+

Object of the given type

+
+
+ +
+
+abstract get_service(instance_type: Type) → Optional[collections.abc.Callable[object]]
+

Returns instance of given type

+
+
+
instance_type: Type

The type of the searched instance

+
+
+
+
+

Object of type Optional[Callable[object]]

+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cpl.environment.html b/docs/build/html/cpl.environment.html new file mode 100644 index 00000000..51bf8f47 --- /dev/null +++ b/docs/build/html/cpl.environment.html @@ -0,0 +1,421 @@ + + + + + + + + + + cpl.environment — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl.environment

+
+

cpl.environment.application_environment

+
+
+class cpl.environment.application_environment.ApplicationEnvironment(name: cpl.environment.environment_name_enum.EnvironmentNameEnum = <EnvironmentNameEnum.production: 'production'>)
+

Bases: cpl.environment.application_environment_abc.ApplicationEnvironmentABC

+

Represents environment of the application

+
+
+
+
+property application_name
+
+ +
+
+property customer
+
+ +
+
+property date_time_now
+
+ +
+
+property end_time
+
+ +
+
+property environment_name
+
+ +
+
+property host_name
+
+ +
+
+property runtime_directory
+
+ +
+
+set_runtime_directory(runtime_directory: str)
+

Sets the current runtime directory

+
+
+
runtime_directory: str

Path of the runtime directory

+
+
+
+
+ +
+
+set_working_directory(working_directory: str)
+

Sets the current working directory

+
+
+
working_directory: str

Path of the current working directory

+
+
+
+
+ +
+
+property start_time
+
+ +
+
+property working_directory
+
+ +
+ +
+
+

cpl.environment.application_environment_abc

+
+
+class cpl.environment.application_environment_abc.ApplicationEnvironmentABC
+

Bases: abc.ABC

+

ABC of the class cpl.environment.application_environment.ApplicationEnvironment

+
+
+abstract property application_name
+
+ +
+
+abstract property customer
+
+ +
+
+abstract property date_time_now
+
+ +
+
+abstract property end_time
+
+ +
+
+abstract property environment_name
+
+ +
+
+abstract property host_name
+
+ +
+
+abstract property runtime_directory
+
+ +
+
+abstract set_runtime_directory(runtime_directory: str)
+

Sets the current runtime directory

+
+
+
runtime_directory: str

Path of the runtime directory

+
+
+
+
+ +
+
+abstract set_working_directory(working_directory: str)
+

Sets the current working directory

+
+
+
working_directory: str

Path of the current working directory

+
+
+
+
+ +
+
+abstract property start_time
+
+ +
+
+abstract property working_directory
+
+ +
+ +
+
+

cpl.environment.environment_name_enum

+
+
+class cpl.environment.environment_name_enum.EnvironmentNameEnum(value)
+

Bases: enum.Enum

+

An enumeration.

+
+
+development = 'development'
+
+ +
+
+production = 'production'
+
+ +
+
+staging = 'staging'
+
+ +
+
+testing = 'testing'
+
+ +
+ +
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cpl.html b/docs/build/html/cpl.html new file mode 100644 index 00000000..ee538148 --- /dev/null +++ b/docs/build/html/cpl.html @@ -0,0 +1,309 @@ + + + + + + + + + + API Reference — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

API Reference

+
+ +
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cpl.logging.html b/docs/build/html/cpl.logging.html new file mode 100644 index 00000000..db145dc8 --- /dev/null +++ b/docs/build/html/cpl.logging.html @@ -0,0 +1,582 @@ + + + + + + + + + + cpl.logging — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl.logging

+
+

cpl.logging.logger_abc

+
+
+class cpl.logging.logger_abc.LoggerABC
+

Bases: abc.ABC

+

ABC for cpl.logging.logger_service.Logger

+
+
+abstract debug(name: str, message: str)
+

Writes a debug message

+
+
+
name: str

Message name

+
+
message: str

Message string

+
+
+
+
+ +
+
+abstract error(name: str, message: str, ex: Optional[Exception] = None)
+

Writes an error

+
+
+
name: str

Error name

+
+
message: str

Error message

+
+
ex: Exception

Thrown exception

+
+
+
+
+ +
+
+abstract fatal(name: str, message: str, ex: Optional[Exception] = None)
+

Writes an error and ends the program

+
+
+
name: str

Error name

+
+
message: str

Error message

+
+
ex: Exception

Thrown exception

+
+
+
+
+ +
+
+abstract header(string: str)
+

Writes a header message

+
+
+
string: str

String to write as header

+
+
+
+
+ +
+
+abstract info(name: str, message: str)
+

Writes an information

+
+
+
name: str

Message name

+
+
message: str

Message string

+
+
+
+
+ +
+
+abstract trace(name: str, message: str)
+

Writes a trace message

+
+
+
name: str

Message name

+
+
message: str

Message string

+
+
+
+
+ +
+
+abstract warn(name: str, message: str)
+

Writes an warning

+
+
+
name: str

Message name

+
+
message: str

Message string

+
+
+
+
+ +
+ +
+
+

cpl.logging.logger_service

+
+
+class cpl.logging.logger_service.Logger(logging_settings: cpl.logging.logging_settings.LoggingSettings, time_format: cpl.time.time_format_settings.TimeFormatSettings, env: cpl.environment.application_environment_abc.ApplicationEnvironmentABC)
+

Bases: cpl.logging.logger_abc.LoggerABC

+

Service for logging

+
+
+
logging_settings: cpl.logging.logging_settings.LoggingSettings

Settings for the logger

+
+
time_format: cpl.time.time_format_settings.TimeFormatSettings

Time format settings

+
+
env: cpl.environment.application_environment_abc.ApplicationEnvironmentABC

Environment of the application

+
+
+
+
+
+create() → None
+

Creates path tree and logfile

+
+ +
+
+debug(name: str, message: str)
+

Writes a debug message

+
+
+
name: str

Message name

+
+
message: str

Message string

+
+
+
+
+ +
+
+error(name: str, message: str, ex: Optional[Exception] = None)
+

Writes an error

+
+
+
name: str

Error name

+
+
message: str

Error message

+
+
ex: Exception

Thrown exception

+
+
+
+
+ +
+
+fatal(name: str, message: str, ex: Optional[Exception] = None)
+

Writes an error and ends the program

+
+
+
name: str

Error name

+
+
message: str

Error message

+
+
ex: Exception

Thrown exception

+
+
+
+
+ +
+
+header(string: str)
+

Writes a header message

+
+
+
string: str

String to write as header

+
+
+
+
+ +
+
+info(name: str, message: str)
+

Writes an information

+
+
+
name: str

Message name

+
+
message: str

Message string

+
+
+
+
+ +
+
+trace(name: str, message: str)
+

Writes a trace message

+
+
+
name: str

Message name

+
+
message: str

Message string

+
+
+
+
+ +
+
+warn(name: str, message: str)
+

Writes an warning

+
+
+
name: str

Message name

+
+
message: str

Message string

+
+
+
+
+ +
+ +
+
+

cpl.logging.logging_level_enum

+
+
+class cpl.logging.logging_level_enum.LoggingLevelEnum(value)
+

Bases: enum.Enum

+

An enumeration.

+
+
+DEBUG = 5
+
+ +
+
+ERROR = 2
+
+ +
+
+FATAL = 1
+
+ +
+
+INFO = 4
+
+ +
+
+OFF = 0
+
+ +
+
+TRACE = 6
+
+ +
+
+WARN = 3
+
+ +
+ +
+
+

cpl.logging.logging_settings

+
+
+class cpl.logging.logging_settings.LoggingSettings
+

Bases: cpl.configuration.configuration_model_abc.ConfigurationModelABC

+

Representation of logging settings

+
+
+property console
+
+ +
+
+property filename
+
+ +
+
+from_dict(settings: dict)
+

Converts attributes to dict

+
+

settings: dict

+
+
+ +
+
+property level
+
+ +
+
+property path
+
+ +
+ +
+
+

cpl.logging.logging_settings_name_enum

+
+
+class cpl.logging.logging_settings_name_enum.LoggingSettingsNameEnum(value)
+

Bases: enum.Enum

+

An enumeration.

+
+
+console_level = 'ConsoleLogLevel'
+
+ +
+
+file_level = 'FileLogLevel'
+
+ +
+
+filename = 'Filename'
+
+ +
+
+path = 'Path'
+
+ +
+ +
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cpl.mailing.html b/docs/build/html/cpl.mailing.html new file mode 100644 index 00000000..3a64c1a4 --- /dev/null +++ b/docs/build/html/cpl.mailing.html @@ -0,0 +1,492 @@ + + + + + + + + + + cpl.mailing — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl.mailing

+
+

cpl.mailing.email

+
+
+class cpl.mailing.email.EMail(header: Optional[list] = None, subject: Optional[str] = None, body: Optional[str] = None, transceiver: Optional[str] = None, receiver: Optional[list] = None)
+

Bases: object

+

Represents an email

+
+
+
header: list[str]

Header of the E-Mail

+
+
subject: str

Subject of the E-Mail

+
+
body: str

Body of the E-Mail

+
+
transceiver: str

Transceiver of the E-Mail

+
+
receiver: list[str]

Receiver of the E-Mail

+
+
+
+
+
+add_header(header: str)
+

Adds header

+
+
+
header: str

The header of the E-Mail

+
+
+
+
+ +
+
+add_receiver(receiver: str)
+

Adds receiver

+
+
+
receiver: str

The receiver of the E-Mail

+
+
+
+
+ +
+
+property body
+
+ +
+
+static check_mail(address: str) → bool
+

Checks if an email is valid

+
+
+
address: str

The address to check

+
+
+
+
+

Result if E-Mail is valid or not

+
+
+ +
+
+get_content(transceiver: str)
+

Returns the mail as string

+
+
+
transceiver: str

The transceiver of the E-Mail

+
+
+
+
+

E-Mail as string

+
+
+ +
+
+property header
+
+ +
+
+property header_list
+
+ +
+
+property receiver
+
+ +
+
+property receiver_list
+
+ +
+
+property subject
+
+ +
+
+property transceiver
+
+ +
+ +
+
+

cpl.mailing.email_client_abc

+
+
+class cpl.mailing.email_client_abc.EMailClientABC
+

Bases: abc.ABC

+

ABC of cpl.mailing.email_client_service.EMailClient

+
+
+abstract connect()
+

Connects to server

+
+ +
+
+abstract send_mail(email: cpl.mailing.email.EMail)
+

Sends email

+
+
+
email: cpl.mailing.email.EMail

Object of the E-Mail to send

+
+
+
+
+ +
+ +
+
+

cpl.mailing.email_client_service

+
+
+class cpl.mailing.email_client_service.EMailClient(environment: cpl.environment.application_environment_abc.ApplicationEnvironmentABC, logger: cpl.logging.logger_abc.LoggerABC, mail_settings: cpl.mailing.email_client_settings.EMailClientSettings)
+

Bases: cpl.mailing.email_client_abc.EMailClientABC

+

Service to send emails

+
+
+
environment: cpl.environment.application_environment_abc.ApplicationEnvironmentABC

Environment of the application

+
+
logger: cpl.logging.logger_abc.LoggerABC

The logger to use

+
+
mail_settings: cpl.mailing.email_client_settings.EMailClientSettings

Settings for mailing

+
+
+
+
+
+connect()
+

Connects to server

+
+ +
+
+create()
+

Creates connection

+
+ +
+
+login()
+

Login to server

+
+ +
+
+send_mail(email: cpl.mailing.email.EMail)
+

Sends email

+
+
+
email: cpl.mailing.email.EMail

Object of the E-Mail to send

+
+
+
+
+ +
+ +
+
+

cpl.mailing.email_client_settings

+
+
+class cpl.mailing.email_client_settings.EMailClientSettings
+

Bases: cpl.configuration.configuration_model_abc.ConfigurationModelABC

+

Representation of mailing settings

+
+
+property credentials
+
+ +
+
+from_dict(settings: dict)
+

Converts attributes to dict

+
+

settings: dict

+
+
+ +
+
+property host
+
+ +
+
+property port
+
+ +
+
+property user_name
+
+ +
+ +
+
+

cpl.mailing.email_client_settings_name_enum

+
+
+class cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum(value)
+

Bases: enum.Enum

+

An enumeration.

+
+
+credentials = 'Credentials'
+
+ +
+
+host = 'Host'
+
+ +
+
+port = 'Port'
+
+ +
+
+user_name = 'UserName'
+
+ +
+ +
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cpl.time.html b/docs/build/html/cpl.time.html new file mode 100644 index 00000000..0bed97b7 --- /dev/null +++ b/docs/build/html/cpl.time.html @@ -0,0 +1,298 @@ + + + + + + + + + + cpl.time — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl.time

+
+

cpl.time.time_format_settings

+
+
+class cpl.time.time_format_settings.TimeFormatSettings
+

Bases: cpl.configuration.configuration_model_abc.ConfigurationModelABC

+

Representation of time format settings

+
+
+property date_format
+
+ +
+
+property date_time_format
+
+ +
+
+property date_time_log_format
+
+ +
+
+from_dict(settings: dict)
+

Converts attributes to dict

+
+

settings: dict

+
+
+ +
+
+property time_format
+
+ +
+ +
+
+

cpl.time.time_format_settings_names_enum

+
+
+class cpl.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum(value)
+

Bases: enum.Enum

+

An enumeration.

+
+
+date_format = 'DateFormat'
+
+ +
+
+date_time_format = 'DateTimeFormat'
+
+ +
+
+date_time_log_format = 'DateTimeLogFormat'
+
+ +
+
+time_format = 'TimeFormat'
+
+ +
+ +
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cpl.utils.html b/docs/build/html/cpl.utils.html new file mode 100644 index 00000000..8134344b --- /dev/null +++ b/docs/build/html/cpl.utils.html @@ -0,0 +1,456 @@ + + + + + + + + + + cpl.utils — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl.utils

+
+

cpl.utils.credential_manager

+
+
+class cpl.utils.credential_manager.CredentialManager
+

Bases: object

+

Handles credential encryption and decryption

+
+
+static build_string(string: str, credentials: str)
+

Builds string with credentials in it

+
+
+
string: str

String in which the variable is replaced by credentials

+
+
credentials: str

String to encode

+
+
+
+
+

Decoded string

+
+
+ +
+
+static decrypt(string: str) → str
+

Decode with base64

+
+
+
string: str

String to decode

+
+
+
+
+

Decoded string

+
+
+ +
+
+static encrypt(string: str) → str
+

Encode with base64

+
+
+
string: str

String to encode

+
+
+
+
+

Encoded string

+
+
+ +
+ +
+
+

cpl.utils.pip

+
+
+class cpl.utils.pip.Pip
+

Bases: object

+

Executes pip commands

+
+
+classmethod get_executable() → str
+
+ +
+
+classmethod get_outdated() → bytes
+

Gets table of outdated packages

+
+

Bytes string of the command result

+
+
+ +
+
+classmethod get_package(package: str) → Optional[str]
+

Gets given package py local pip list

+
+

package: str

+
+
+

The package name as string

+
+
+ +
+
+classmethod install(package: str, *args, source: Optional[str] = None, stdout=None, stderr=None)
+

Installs given package

+
+
+
package: str

The name of the package

+
+
args: list

Arguments for the command

+
+
source: str

Extra index URL

+
+
stdout: str

Stdout of subprocess.run

+
+
stderr: str

Stderr of subprocess.run

+
+
+
+
+ +
+
+classmethod reset_executable()
+

Resets the executable to system standard

+
+ +
+
+classmethod set_executable(executable: str)
+

Sets the executable

+
+
+
executable: str

The python command

+
+
+
+
+ +
+
+classmethod uninstall(package: str, stdout=None, stderr=None)
+

Uninstalls given package

+
+
+
package: str

The name of the package

+
+
stdout: str

Stdout of subprocess.run

+
+
stderr: str

Stderr of subprocess.run

+
+
+
+
+ +
+ +
+
+

cpl.utils.string

+
+
+class cpl.utils.string.String
+

Bases: object

+

Useful functions for strings

+
+
+static convert_to_camel_case(chars: str) → str
+

Converts string to camel case

+
+
+
chars: str

String to convert

+
+
+
+
+

String converted to CamelCase

+
+
+ +
+
+static convert_to_snake_case(chars: str) → str
+

Converts string to snake case

+
+
+
chars: str

String to convert

+
+
+
+
+

String converted to snake_case

+
+
+ +
+
+static first_to_lower(chars: str) → str
+

Converts first char to lower

+
+
+
chars: str

String to convert

+
+
+
+
+

String with first char as lower

+
+
+ +
+
+static first_to_upper(chars: str) → str
+

Converts first char to upper

+
+
+
chars: str

String to convert

+
+
+
+
+

String with first char as upper

+
+
+ +
+
+static random_string(chars: str, length: int) → str
+

Creates random string by given chars and length

+
+

String of random chars

+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/cpl_cli.html b/docs/build/html/cpl_cli.html new file mode 100644 index 00000000..3ceab249 --- /dev/null +++ b/docs/build/html/cpl_cli.html @@ -0,0 +1,296 @@ + + + + + + + + + + CLI Reference — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+ + +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html new file mode 100644 index 00000000..9614d45b --- /dev/null +++ b/docs/build/html/genindex.html @@ -0,0 +1,1477 @@ + + + + + + + + + + Index — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
    + +
  • »
    • + +
  • Index
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ + +

Index

+ +
+ A + | B + | C + | D + | E + | F + | G + | H + | I + | L + | M + | N + | O + | P + | R + | S + | T + | U + | V + | W + | Y + +
+

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + + +
+ +

F

+ + + +
+ +

G

+ + + +
+ +

H

+ + + +
+ +

I

+ + + +
+ +

L

+ + + +
+ +

M

+ + +
+ +

N

+ + + +
+ +

O

+ + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ +

V

+ + +
+ +

W

+ + + +
+ +

Y

+ + +
+ + + +
+ +
+
+ +
+ +
+

+ © Copyright 2021, Sven Heidemann. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/getting_started.html b/docs/build/html/getting_started.html new file mode 100644 index 00000000..e38531a6 --- /dev/null +++ b/docs/build/html/getting_started.html @@ -0,0 +1,238 @@ + + + + + + + + + + Getting started — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+ + +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/index.html b/docs/build/html/index.html new file mode 100644 index 00000000..4555bae0 --- /dev/null +++ b/docs/build/html/index.html @@ -0,0 +1,223 @@ + + + + + + + + + + Introduction to the CPL Docs — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Introduction to the CPL Docs

+

The Common Python Library (CPL) is a package for python and a development platform meant to help you create simple and efficient server and desktop applications.

+

This CPL docs help you learn, understand and use the package. From your first application to complex apps for enterprises.

+
+

Manuals

+

These pages go into great detail about everything the Library can do.

+
+ +
+
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/introduction.html b/docs/build/html/introduction.html new file mode 100644 index 00000000..f20b6f78 --- /dev/null +++ b/docs/build/html/introduction.html @@ -0,0 +1,225 @@ + + + + + + + + + + Introduction to the CPL Docs — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Introduction to the CPL Docs

+

The Common Python Library (CPL) is a package for python and a development platform meant to help you create simple and efficient server and desktop applications.

+

This CPL docs help you learn, understand and use the package. From your first application to complex apps for enterprises.

+ +
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/modules.html b/docs/build/html/modules.html new file mode 100644 index 00000000..c30f19e7 --- /dev/null +++ b/docs/build/html/modules.html @@ -0,0 +1,385 @@ + + + + + + + + + + cpl — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

cpl

+
+ +
+
+ + +
+ +
+
+ +
+ +
+

+ © Copyright 2021, Sven Heidemann. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv new file mode 100644 index 00000000..c9bf48dc Binary files /dev/null and b/docs/build/html/objects.inv differ diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html new file mode 100644 index 00000000..4f44e673 --- /dev/null +++ b/docs/build/html/py-modindex.html @@ -0,0 +1,444 @@ + + + + + + + + + + Python Module Index — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
    + +
  • »
    • + +
  • Python Module Index
    • + + +
  • + +
    • + +
+ + +
+
+
+
+ + +

Python Module Index

+ +
+ c +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ c
+ cpl +
    + cpl.application.application_abc +
    + cpl.application.application_builder +
    + cpl.application.application_builder_abc +
    + cpl.application.startup_abc +
    + cpl.configuration.configuration +
    + cpl.configuration.configuration_abc +
    + cpl.configuration.configuration_model_abc +
    + cpl.configuration.configuration_variable_name_enum +
    + cpl.configuration.console_argument +
    + cpl.console.background_color_enum +
    + cpl.console.console +
    + cpl.console.console_call +
    + cpl.console.foreground_color_enum +
    + cpl.console.spinner_thread +
    + cpl.database.connection.database_connection +
    + cpl.database.connection.database_connection_abc +
    + cpl.database.context.database_context +
    + cpl.database.context.database_context_abc +
    + cpl.database.database_model +
    + cpl.database.database_settings +
    + cpl.database.database_settings_name_enum +
    + cpl.dependency_injection.service_collection +
    + cpl.dependency_injection.service_collection_abc +
    + cpl.dependency_injection.service_descriptor +
    + cpl.dependency_injection.service_lifetime_enum +
    + cpl.dependency_injection.service_provider +
    + cpl.dependency_injection.service_provider_abc +
    + cpl.environment.application_environment +
    + cpl.environment.application_environment_abc +
    + cpl.environment.environment_name_enum +
    + cpl.logging.logger_abc +
    + cpl.logging.logger_service +
    + cpl.logging.logging_level_enum +
    + cpl.logging.logging_settings +
    + cpl.logging.logging_settings_name_enum +
    + cpl.mailing.email +
    + cpl.mailing.email_client_abc +
    + cpl.mailing.email_client_service +
    + cpl.mailing.email_client_settings +
    + cpl.mailing.email_client_settings_name_enum +
    + cpl.time.time_format_settings +
    + cpl.time.time_format_settings_names_enum +
    + cpl.utils.credential_manager +
    + cpl.utils.pip +
    + cpl.utils.string +
+ + +
+ +
+
+ +
+ +
+

+ © Copyright 2021, Sven Heidemann. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/quickstart.html b/docs/build/html/quickstart.html new file mode 100644 index 00000000..3f7a56fa --- /dev/null +++ b/docs/build/html/quickstart.html @@ -0,0 +1,415 @@ + + + + + + + + + + Getting started with CPL — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Getting started with CPL

+

Welcome to CPL!

+

This tutorial introduces you to the essentials of the CPL package by walking through building an console based app.

+ +
+

Prerequisites

+

To get most out of this tutorial you should already have a basic understanding of the following.

+ +

Also you need to have the following installed.

+ +
+
+

Create the project

+

To create the sample project to the following:

+
    +

  1. Open a terminal

    2. +

  2. Run

    +
    cpl new console sample-project
+
    +
    +
    3. +

  3. We don’t want to use Application base or Dependency injection:

    +
    Do you want to use application base? (y/n) n
+
+Do you want to use service providing? (y/n) n
+
    +
    +

    The ouput should look like this:

    +
    Creating sample-project/LICENSE                                                                     done
+Creating sample-project/README.md                                                                   done
+Creating sample-project/src/tests/__init__.py                                                       done
+Creating sample-project/appsettings.json                                                            done
+Creating sample-project/src/sample-project/__init__.py                                              done
+Creating sample-project/src/sample-projectmain.py                                                   done
+
    +
    +
    4. +

  4. Open the project with an IDE like VS Code or PyCharm

    +

    IDE

    +
    5. +

  5. Set the ‘src’ directory as source folder

    +

    IDE set src folder

    +
    6. +

  6. Run the application

    +

    You should see an output like:

    +
    Hello World
+
    +
    +
    7. +

  7. In PyCharm you have to enable Emulate terminal in output console!

    +

    IDE emulate console

    +
    8. +
+
+
+

Create a menu

+
    +

  1. Open the ‘sample-project/main.py’

    2. +

  2. Change ‘Hello World’ to ‘Password generator:’ in line 5

    3. +

  3. Add Console.select as follows:

    +
    from cpl.console import Console
+
+
+def main():
+    Console.write_line('Password generator:')
+    options = [
+        'Only lower case',
+        'Only upper case',
+        'Lower and upper case'
+        'Exit'
+    ]
+    option = Console.select('>', 'Select option: ', options)
+
+
+if __name__ == '__main__':
+    main()
+
+
    +
    +
    4. +

  4. Get Id of the selected option:

    +
    index = options.index(option)
+
    +
    +
    5. +

  5. Create the generate function as follows:

    +
    def generate_password(letters: str, length: int) -> str:
+    return ''.join(random.choice(letters) for i in range(length))
+
    +
    +

    Add imports:

    +
    import random
+import string
+
    +
    +
    6. +

  6. Get length of the password:

    +
    length = int(Console.read('Length: '))
+
    +
    +
    7. +

  7. Validate the selected option:

    +
    index = options.index(option)
+letters = ''
+
+if index == 0:
+    letters = string.ascii_lowercase
+elif index == 1:
+    letters = string.ascii_uppercase
+elif index == 2:
+    letters = string.ascii_letters
+elif index == len(options) - 1:
+    exit()
+
    +
    +
    8. +

  8. Print the generated password:

    +
    Console.write_line('Password: ', generate_password(letters, length))
+
    +
    +
    9. +

  9. The full ‘sample-project/main.py’:

    +
    import random
+import string
+
+from cpl.console import Console
+
+
+def generate_password(letters: str, length: int) -> str:
+    return ''.join(random.choice(letters) for i in range(length))
+
+
+def main():
+    Console.write_line('Password generator:')
+    options = [
+        'Only lower case',
+        'Only upper case',
+        'Lower and upper case',
+        'Exit'
+    ]
+    option = Console.select('>', 'Select option: ', options)
+
+    length = int(Console.read('Length: '))
+
+    index = options.index(option)
+    letters = ''
+    if index == 0:
+        letters = string.ascii_lowercase
+    elif index == 1:
+        letters = string.ascii_uppercase
+    elif index == 2:
+        letters = string.ascii_letters
+    elif index == len(options) - 1:
+        exit()
+
+    Console.write_line('Password: ', generate_password(letters, length))
+
+
+if __name__ == '__main__':
+    main()
+
+
    +
    +
    10. +
+
+
+

What’s next

+

In this section, you’ve created an application that uses user input to generate a password.

+

To continue exploring CPL and developing applications:

+ + +
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/search.html b/docs/build/html/search.html new file mode 100644 index 00000000..52594847 --- /dev/null +++ b/docs/build/html/search.html @@ -0,0 +1,219 @@ + + + + + + + + + + Search — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
    + +
  • »
    • + +
  • Search
    • + + +
  • + +
    • + +
+ + +
+
+
+
+ + + + +
+ +
+ +
+ +
+
+ +
+ +
+

+ © Copyright 2021, Sven Heidemann. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js new file mode 100644 index 00000000..b7a1c995 --- /dev/null +++ b/docs/build/html/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["cli.add","cli.build","cli.generate","cli.help","cli.install","cli.new","cli.overview","cli.publish","cli.remove","cli.start","cli.uninstall","cli.update","cli.version","contributing","cpl","cpl.application","cpl.configuration","cpl.console","cpl.database","cpl.database.connection","cpl.database.context","cpl.dependency_injection","cpl.environment","cpl.logging","cpl.mailing","cpl.time","cpl.utils","cpl_cli","getting_started","index","introduction","modules","quickstart","setup"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["cli.add.md","cli.build.md","cli.generate.md","cli.help.md","cli.install.md","cli.new.md","cli.overview.md","cli.publish.md","cli.remove.md","cli.start.md","cli.uninstall.md","cli.update.md","cli.version.md","contributing.md","cpl.rst","cpl.application.rst","cpl.configuration.rst","cpl.console.rst","cpl.database.rst","cpl.database.connection.rst","cpl.database.context.rst","cpl.dependency_injection.rst","cpl.environment.rst","cpl.logging.rst","cpl.mailing.rst","cpl.time.rst","cpl.utils.rst","cpl_cli.rst","getting_started.rst","index.rst","introduction.md","modules.rst","quickstart.md","setup.md"],objects:{"cpl.application":{application_abc:[15,0,0,"-"],application_builder:[15,0,0,"-"],application_builder_abc:[15,0,0,"-"],startup_abc:[15,0,0,"-"]},"cpl.application.application_abc":{ApplicationABC:[15,1,1,""]},"cpl.application.application_abc.ApplicationABC":{configure:[15,2,1,""],main:[15,2,1,""],run:[15,2,1,""]},"cpl.application.application_builder":{ApplicationBuilder:[15,1,1,""]},"cpl.application.application_builder.ApplicationBuilder":{build:[15,2,1,""],use_startup:[15,2,1,""]},"cpl.application.application_builder_abc":{ApplicationBuilderABC:[15,1,1,""]},"cpl.application.application_builder_abc.ApplicationBuilderABC":{build:[15,2,1,""],use_startup:[15,2,1,""]},"cpl.application.startup_abc":{StartupABC:[15,1,1,""]},"cpl.application.startup_abc.StartupABC":{configure_configuration:[15,2,1,""],configure_services:[15,2,1,""]},"cpl.configuration":{configuration:[16,0,0,"-"],configuration_abc:[16,0,0,"-"],configuration_model_abc:[16,0,0,"-"],configuration_variable_name_enum:[16,0,0,"-"],console_argument:[16,0,0,"-"]},"cpl.configuration.configuration":{Configuration:[16,1,1,""]},"cpl.configuration.configuration.Configuration":{add_configuration:[16,2,1,""],add_console_argument:[16,2,1,""],add_console_arguments:[16,2,1,""],add_environment_variables:[16,2,1,""],add_json_file:[16,2,1,""],additional_arguments:[16,2,1,""],argument_error_function:[16,2,1,""],environment:[16,2,1,""],get_configuration:[16,2,1,""]},"cpl.configuration.configuration_abc":{ConfigurationABC:[16,1,1,""]},"cpl.configuration.configuration_abc.ConfigurationABC":{add_configuration:[16,2,1,""],add_console_argument:[16,2,1,""],add_console_arguments:[16,2,1,""],add_environment_variables:[16,2,1,""],add_json_file:[16,2,1,""],additional_arguments:[16,2,1,""],argument_error_function:[16,2,1,""],environment:[16,2,1,""],get_configuration:[16,2,1,""]},"cpl.configuration.configuration_model_abc":{ConfigurationModelABC:[16,1,1,""]},"cpl.configuration.configuration_model_abc.ConfigurationModelABC":{from_dict:[16,2,1,""]},"cpl.configuration.configuration_variable_name_enum":{ConfigurationVariableNameEnum:[16,1,1,""]},"cpl.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum":{customer:[16,3,1,""],environment:[16,3,1,""],name:[16,3,1,""],to_list:[16,2,1,""]},"cpl.configuration.console_argument":{ConsoleArgument:[16,1,1,""]},"cpl.configuration.console_argument.ConsoleArgument":{aliases:[16,2,1,""],console_arguments:[16,2,1,""],is_value_token_optional:[16,2,1,""],name:[16,2,1,""],token:[16,2,1,""],value_token:[16,2,1,""]},"cpl.console":{background_color_enum:[17,0,0,"-"],console:[17,0,0,"-"],console_call:[17,0,0,"-"],foreground_color_enum:[17,0,0,"-"],spinner_thread:[17,0,0,"-"]},"cpl.console.background_color_enum":{BackgroundColorEnum:[17,1,1,""]},"cpl.console.background_color_enum.BackgroundColorEnum":{"default":[17,3,1,""],blue:[17,3,1,""],cyan:[17,3,1,""],green:[17,3,1,""],grey:[17,3,1,""],magenta:[17,3,1,""],red:[17,3,1,""],white:[17,3,1,""],yellow:[17,3,1,""]},"cpl.console.console":{Console:[17,1,1,""]},"cpl.console.console.Console":{background_color:[17,3,1,""],banner:[17,2,1,""],clear:[17,2,1,""],close:[17,2,1,""],color_reset:[17,2,1,""],disable:[17,2,1,""],enable:[17,2,1,""],error:[17,2,1,""],foreground_color:[17,3,1,""],read:[17,2,1,""],read_line:[17,2,1,""],reset_cursor_position:[17,2,1,""],select:[17,2,1,""],set_background_color:[17,2,1,""],set_cursor_position:[17,2,1,""],set_foreground_color:[17,2,1,""],set_hold_back:[17,2,1,""],spinner:[17,2,1,""],table:[17,2,1,""],write:[17,2,1,""],write_at:[17,2,1,""],write_line:[17,2,1,""],write_line_at:[17,2,1,""]},"cpl.console.console_call":{ConsoleCall:[17,1,1,""]},"cpl.console.console_call.ConsoleCall":{"function":[17,2,1,""],args:[17,2,1,""]},"cpl.console.foreground_color_enum":{ForegroundColorEnum:[17,1,1,""]},"cpl.console.foreground_color_enum.ForegroundColorEnum":{"default":[17,3,1,""],blue:[17,3,1,""],cyan:[17,3,1,""],green:[17,3,1,""],grey:[17,3,1,""],magenta:[17,3,1,""],red:[17,3,1,""],white:[17,3,1,""],yellow:[17,3,1,""]},"cpl.console.spinner_thread":{SpinnerThread:[17,1,1,""]},"cpl.console.spinner_thread.SpinnerThread":{exit:[17,2,1,""],run:[17,2,1,""],stop_spinning:[17,2,1,""]},"cpl.database":{database_model:[18,0,0,"-"],database_settings:[18,0,0,"-"],database_settings_name_enum:[18,0,0,"-"]},"cpl.database.connection":{database_connection:[19,0,0,"-"],database_connection_abc:[19,0,0,"-"]},"cpl.database.connection.database_connection":{DatabaseConnection:[19,1,1,""]},"cpl.database.connection.database_connection.DatabaseConnection":{connect:[19,2,1,""],engine:[19,2,1,""],session:[19,2,1,""]},"cpl.database.connection.database_connection_abc":{DatabaseConnectionABC:[19,1,1,""]},"cpl.database.connection.database_connection_abc.DatabaseConnectionABC":{connect:[19,2,1,""],engine:[19,2,1,""],session:[19,2,1,""]},"cpl.database.context":{database_context:[20,0,0,"-"],database_context_abc:[20,0,0,"-"]},"cpl.database.context.database_context":{DatabaseContext:[20,1,1,""]},"cpl.database.context.database_context.DatabaseContext":{connect:[20,2,1,""],engine:[20,2,1,""],save_changes:[20,2,1,""],session:[20,2,1,""]},"cpl.database.context.database_context_abc":{DatabaseContextABC:[20,1,1,""]},"cpl.database.context.database_context_abc.DatabaseContextABC":{connect:[20,2,1,""],engine:[20,2,1,""],save_changes:[20,2,1,""],session:[20,2,1,""]},"cpl.database.database_settings":{DatabaseSettings:[18,1,1,""]},"cpl.database.database_settings.DatabaseSettings":{auth_plugin:[18,2,1,""],case_sensitive:[18,2,1,""],connection_string:[18,2,1,""],credentials:[18,2,1,""],echo:[18,2,1,""],encoding:[18,2,1,""],from_dict:[18,2,1,""]},"cpl.database.database_settings_name_enum":{DatabaseSettingsNameEnum:[18,1,1,""]},"cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum":{auth_plugin:[18,3,1,""],case_sensitive:[18,3,1,""],connection_string:[18,3,1,""],credentials:[18,3,1,""],echo:[18,3,1,""],encoding:[18,3,1,""]},"cpl.dependency_injection":{service_collection:[21,0,0,"-"],service_collection_abc:[21,0,0,"-"],service_descriptor:[21,0,0,"-"],service_lifetime_enum:[21,0,0,"-"],service_provider:[21,0,0,"-"],service_provider_abc:[21,0,0,"-"]},"cpl.dependency_injection.service_collection":{ServiceCollection:[21,1,1,""]},"cpl.dependency_injection.service_collection.ServiceCollection":{add_db_context:[21,2,1,""],add_logging:[21,2,1,""],add_scoped:[21,2,1,""],add_singleton:[21,2,1,""],add_transient:[21,2,1,""],build_service_provider:[21,2,1,""]},"cpl.dependency_injection.service_collection_abc":{ServiceCollectionABC:[21,1,1,""]},"cpl.dependency_injection.service_collection_abc.ServiceCollectionABC":{add_db_context:[21,2,1,""],add_logging:[21,2,1,""],add_scoped:[21,2,1,""],add_singleton:[21,2,1,""],add_transient:[21,2,1,""],build_service_provider:[21,2,1,""]},"cpl.dependency_injection.service_descriptor":{ServiceDescriptor:[21,1,1,""]},"cpl.dependency_injection.service_descriptor.ServiceDescriptor":{implementation:[21,2,1,""],lifetime:[21,2,1,""],service_type:[21,2,1,""]},"cpl.dependency_injection.service_lifetime_enum":{ServiceLifetimeEnum:[21,1,1,""]},"cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum":{"transient":[21,3,1,""],scoped:[21,3,1,""],singleton:[21,3,1,""]},"cpl.dependency_injection.service_provider":{ServiceProvider:[21,1,1,""]},"cpl.dependency_injection.service_provider.ServiceProvider":{build_service:[21,2,1,""],get_service:[21,2,1,""]},"cpl.dependency_injection.service_provider_abc":{ServiceProviderABC:[21,1,1,""]},"cpl.dependency_injection.service_provider_abc.ServiceProviderABC":{build_service:[21,2,1,""],get_service:[21,2,1,""]},"cpl.environment":{application_environment:[22,0,0,"-"],application_environment_abc:[22,0,0,"-"],environment_name_enum:[22,0,0,"-"]},"cpl.environment.application_environment":{ApplicationEnvironment:[22,1,1,""]},"cpl.environment.application_environment.ApplicationEnvironment":{application_name:[22,2,1,""],customer:[22,2,1,""],date_time_now:[22,2,1,""],end_time:[22,2,1,""],environment_name:[22,2,1,""],host_name:[22,2,1,""],runtime_directory:[22,2,1,""],set_runtime_directory:[22,2,1,""],set_working_directory:[22,2,1,""],start_time:[22,2,1,""],working_directory:[22,2,1,""]},"cpl.environment.application_environment_abc":{ApplicationEnvironmentABC:[22,1,1,""]},"cpl.environment.application_environment_abc.ApplicationEnvironmentABC":{application_name:[22,2,1,""],customer:[22,2,1,""],date_time_now:[22,2,1,""],end_time:[22,2,1,""],environment_name:[22,2,1,""],host_name:[22,2,1,""],runtime_directory:[22,2,1,""],set_runtime_directory:[22,2,1,""],set_working_directory:[22,2,1,""],start_time:[22,2,1,""],working_directory:[22,2,1,""]},"cpl.environment.environment_name_enum":{EnvironmentNameEnum:[22,1,1,""]},"cpl.environment.environment_name_enum.EnvironmentNameEnum":{development:[22,3,1,""],production:[22,3,1,""],staging:[22,3,1,""],testing:[22,3,1,""]},"cpl.logging":{logger_abc:[23,0,0,"-"],logger_service:[23,0,0,"-"],logging_level_enum:[23,0,0,"-"],logging_settings:[23,0,0,"-"],logging_settings_name_enum:[23,0,0,"-"]},"cpl.logging.logger_abc":{LoggerABC:[23,1,1,""]},"cpl.logging.logger_abc.LoggerABC":{debug:[23,2,1,""],error:[23,2,1,""],fatal:[23,2,1,""],header:[23,2,1,""],info:[23,2,1,""],trace:[23,2,1,""],warn:[23,2,1,""]},"cpl.logging.logger_service":{Logger:[23,1,1,""]},"cpl.logging.logger_service.Logger":{create:[23,2,1,""],debug:[23,2,1,""],error:[23,2,1,""],fatal:[23,2,1,""],header:[23,2,1,""],info:[23,2,1,""],trace:[23,2,1,""],warn:[23,2,1,""]},"cpl.logging.logging_level_enum":{LoggingLevelEnum:[23,1,1,""]},"cpl.logging.logging_level_enum.LoggingLevelEnum":{DEBUG:[23,3,1,""],ERROR:[23,3,1,""],FATAL:[23,3,1,""],INFO:[23,3,1,""],OFF:[23,3,1,""],TRACE:[23,3,1,""],WARN:[23,3,1,""]},"cpl.logging.logging_settings":{LoggingSettings:[23,1,1,""]},"cpl.logging.logging_settings.LoggingSettings":{console:[23,2,1,""],filename:[23,2,1,""],from_dict:[23,2,1,""],level:[23,2,1,""],path:[23,2,1,""]},"cpl.logging.logging_settings_name_enum":{LoggingSettingsNameEnum:[23,1,1,""]},"cpl.logging.logging_settings_name_enum.LoggingSettingsNameEnum":{console_level:[23,3,1,""],file_level:[23,3,1,""],filename:[23,3,1,""],path:[23,3,1,""]},"cpl.mailing":{email:[24,0,0,"-"],email_client_abc:[24,0,0,"-"],email_client_service:[24,0,0,"-"],email_client_settings:[24,0,0,"-"],email_client_settings_name_enum:[24,0,0,"-"]},"cpl.mailing.email":{EMail:[24,1,1,""]},"cpl.mailing.email.EMail":{add_header:[24,2,1,""],add_receiver:[24,2,1,""],body:[24,2,1,""],check_mail:[24,2,1,""],get_content:[24,2,1,""],header:[24,2,1,""],header_list:[24,2,1,""],receiver:[24,2,1,""],receiver_list:[24,2,1,""],subject:[24,2,1,""],transceiver:[24,2,1,""]},"cpl.mailing.email_client_abc":{EMailClientABC:[24,1,1,""]},"cpl.mailing.email_client_abc.EMailClientABC":{connect:[24,2,1,""],send_mail:[24,2,1,""]},"cpl.mailing.email_client_service":{EMailClient:[24,1,1,""]},"cpl.mailing.email_client_service.EMailClient":{connect:[24,2,1,""],create:[24,2,1,""],login:[24,2,1,""],send_mail:[24,2,1,""]},"cpl.mailing.email_client_settings":{EMailClientSettings:[24,1,1,""]},"cpl.mailing.email_client_settings.EMailClientSettings":{credentials:[24,2,1,""],from_dict:[24,2,1,""],host:[24,2,1,""],port:[24,2,1,""],user_name:[24,2,1,""]},"cpl.mailing.email_client_settings_name_enum":{EMailClientSettingsNameEnum:[24,1,1,""]},"cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum":{credentials:[24,3,1,""],host:[24,3,1,""],port:[24,3,1,""],user_name:[24,3,1,""]},"cpl.time":{time_format_settings:[25,0,0,"-"],time_format_settings_names_enum:[25,0,0,"-"]},"cpl.time.time_format_settings":{TimeFormatSettings:[25,1,1,""]},"cpl.time.time_format_settings.TimeFormatSettings":{date_format:[25,2,1,""],date_time_format:[25,2,1,""],date_time_log_format:[25,2,1,""],from_dict:[25,2,1,""],time_format:[25,2,1,""]},"cpl.time.time_format_settings_names_enum":{TimeFormatSettingsNamesEnum:[25,1,1,""]},"cpl.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum":{date_format:[25,3,1,""],date_time_format:[25,3,1,""],date_time_log_format:[25,3,1,""],time_format:[25,3,1,""]},"cpl.utils":{credential_manager:[26,0,0,"-"],pip:[26,0,0,"-"],string:[26,0,0,"-"]},"cpl.utils.credential_manager":{CredentialManager:[26,1,1,""]},"cpl.utils.credential_manager.CredentialManager":{build_string:[26,2,1,""],decrypt:[26,2,1,""],encrypt:[26,2,1,""]},"cpl.utils.pip":{Pip:[26,1,1,""]},"cpl.utils.pip.Pip":{get_executable:[26,2,1,""],get_outdated:[26,2,1,""],get_package:[26,2,1,""],install:[26,2,1,""],reset_executable:[26,2,1,""],set_executable:[26,2,1,""],uninstall:[26,2,1,""]},"cpl.utils.string":{String:[26,1,1,""]},"cpl.utils.string.String":{convert_to_camel_case:[26,2,1,""],convert_to_snake_case:[26,2,1,""],first_to_lower:[26,2,1,""],first_to_upper:[26,2,1,""],random_string:[26,2,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute"},terms:{"abstract":[2,15,16,19,20,21,22,23,24],"byte":26,"case":[13,26,32],"char":[17,26],"class":[2,15,16,17,18,19,20,21,22,23,24,25,26],"default":[17,33],"enum":[2,16,17,18,21,22,23,24,25],"function":[17,26,32],"import":[13,32],"int":[17,26,32],"new":[6,13,17,27,31,32,33],"public":13,"return":[16,17,21,24,32],"short":[3,6],"static":[16,24,26],"transient":21,"true":16,"while":13,Adding:13,For:13,IDE:32,Such:13,That:13,The:[1,2,4,5,6,7,8,10,13,21,24,26,29,30,32,33],These:29,Useful:[17,26],With:6,__init__:32,__main__:32,__name__:32,abc:[2,15,16,17,19,20,21,22,23,24],abl:13,about:[29,33],absolut:6,accept:13,activ:17,add:[5,6,13,16,21,24,27,31,32],add_configur:16,add_console_argu:16,add_db_context:21,add_environment_vari:16,add_head:24,add_json_fil:16,add_log:21,add_receiv:24,add_scop:21,add_singleton:21,add_transi:21,added:0,addit:[6,13],additional_argu:16,address:24,agre:13,alia:6,alias:[6,16],all:[1,7,8,12,13],allow:13,alreadi:[13,32,33],also:[32,33],ani:[6,17],api:[13,29,30,31],app:[1,6,15,28,29,30,31,32],appli:13,applic:[5,9,14,17,22,23,24,29,30,31,32,33],application_abc:[14,31],application_build:[14,31],application_builder_abc:[14,31],application_environ:[14,31],application_environment_abc:[14,23,24,31],application_nam:22,applicationabc:15,applicationbuild:15,applicationbuilderabc:15,applicationenviron:22,applicationenvironmentabc:[22,23,24],appropri:13,appset:[15,32],arg:[15,17,20,26],argument:[1,5,6,7,16,17,26,27,31],argument_error_funct:16,artifact:6,ascii_lett:32,ascii_lowercas:32,ascii_uppercas:32,ask:13,attribut:[16,18,23,24,25],auth_plugin:18,authplugin:18,automat:13,avail:[3,6,13],back:[13,17],background:17,background_color:17,background_color_enum:[14,31],backgroundcolorenum:17,banner:17,base64:26,base:[2,15,16,17,18,19,20,21,22,23,24,25,26,32],basic:[27,31,32,33],been:13,befor:[13,17],behavior:13,better:13,bit:13,blue:17,bodi:24,bool:[16,17,24],branch:13,build:[6,7,8,15,26,27,31,32,33],build_servic:21,build_service_provid:21,build_str:26,call:[0,15,17],callabl:[16,17,21],camel:26,camelcas:26,can:[0,1,6,7,8,13,29,33],case_sensit:18,casesensit:18,chang:[6,9,13,20,32],channel:13,charact:17,check:24,check_mail:24,checkout:13,chnage:33,choic:32,citizen:13,classmethod:[17,26],clear:17,cli:[12,28,29,30,31,32],close:[13,17],code:[32,33],codebas:13,collect:[16,17,21],color:17,color_reset:17,command:[0,1,3,5,7,8,13,26,27,31,33],commandnameoralia:6,commit:13,common:[29,30],commun:13,complex:[29,30],config:[15,21],configmodel:2,configur:[14,15,18,21,23,24,25,31],configuration_abc:[14,15,21,31],configuration_model_abc:[14,18,23,24,25,31],configuration_variable_name_enum:[14,31],configurationabc:[15,16,21],configurationmodelabc:[16,18,23,24,25],configurationvariablenameenum:16,configure_configur:15,configure_servic:15,confirm:13,connect:[14,18,20,24,31],connection_str:[18,19,20],connectionstr:18,consid:13,consist:13,consol:[1,3,5,6,7,8,14,16,23,28,31,32],console_argu:[14,31],console_cal:[14,31],console_level:23,consoleargu:16,consolecal:17,consoleloglevel:23,contain:15,content:[27,28,31],context:[14,18,21,31,33],continu:32,contributor:13,convert:[16,23,24,25,26],convert_to_camel_cas:26,convert_to_snake_cas:26,coordin:[13,17],copi:1,core:[19,20],count:13,cpl:[6,14,27,28,33],craft:13,creat:[6,7,8,13,15,21,23,24,26,28,29,30,31],credenti:[18,24,26],credential_manag:[14,31],credentialmanag:26,current:[6,22],cursor:17,cursor_background_color:17,cursor_foreground_color:17,custom:[15,16,22],cyan:17,data:[7,8],databas:[14,21,31],database_connect:[14,18,31],database_connection_abc:[14,18,31],database_context:[14,18,31],database_context_abc:[14,18,21,31],database_model:[14,31],database_set:[14,19,20,21,31],database_settings_name_enum:[14,31],databaseconnect:19,databaseconnectionabc:19,databasecontext:20,databasecontextabc:[20,21],databaseset:[18,19,20,21],databasesettingsnameenum:18,date_format:25,date_time_format:25,date_time_log_format:25,date_time_now:22,dateformat:25,datetimeformat:25,datetimelogformat:25,db_context:21,db_context_typ:21,db_set:21,debug:23,declin:33,decod:26,decrypt:26,def:32,defin:[6,16,33],delet:8,deped:4,depend:[6,11,32],dependency_inject:[14,15,31],describ:13,descript:[6,27,31],descriptor:21,design:13,desktop:[29,30],detail:29,determin:13,develop:[6,13,22,29,30,32,33],dict:[16,17,18,23,24,25],directli:[1,13],directori:[1,6,7,8,22,32],disabl:17,discuss:13,dist:[6,7],doc:[19,20],document:13,doesn:13,don:[13,32],done:32,duplic:13,each:6,echo:18,edit:13,edraft:[13,33],effici:[29,30],effort:13,either:6,element:17,elif:32,email:[14,31],email_client_abc:[14,31],email_client_servic:[14,31],email_client_set:[14,31],email_client_settings_name_enum:[14,31],emailcli:24,emailclientabc:24,emailclientset:24,emailclientsettingsnameenum:24,emul:32,enabl:[17,32],encod:[18,26],encrypt:26,end:[17,23],end_tim:22,engin:[19,20],enough:13,ensur:13,enter:33,enterpris:[29,30],entri:[15,17],enumer:[16,17,18,21,22,23,24,25],env:23,environ:[14,16,23,24,28,31],environment_nam:22,environment_name_enum:[14,31],environmentnameenum:22,error:[16,17,23],essenti:[13,32],even:13,everyth:29,except:23,execut:[1,6,7,8,26],exist:13,exit:[17,32],explor:32,extra:[26,33],extract:13,fatal:23,featur:33,file:[1,2,6,7,8,9,13,16,33],file_level:23,fileloglevel:23,filenam:23,find:13,first:[6,13,26,29,30],first_to_low:26,first_to_upp:26,fix:13,fixup:13,folder:32,follow:[6,13,32,33],fore:33,foreground:17,foreground_color:17,foreground_color_enum:[14,31],foregroundcolorenum:17,fork:13,format:[6,23,25],forth:13,found:16,from:[0,6,7,8,10,12,13,15,16,18,29,30,32],from_dict:[16,18,23,24,25],full:32,gener:[5,6,7,8,27,31,32,33],generate_password:32,get:[26,29,30,31,33],get_configur:16,get_cont:24,get_execut:26,get_outd:26,get_packag:26,get_servic:21,git:13,gitea:13,give:13,given:[0,1,4,6,7,10,16,17,18,21,26],going:13,good:13,great:29,green:17,grei:17,guid:13,handl:[17,26],hard:13,has:[0,17],have:[6,13,32,33],haven:13,head:13,header:[17,23,24],header_background_color:17,header_foreground_color:17,header_list:24,hear:13,hello:[32,33],help:[6,13,27,29,30,31],here:[13,33],hold:17,host:24,host_nam:22,html:[19,20],http:[19,20,33],immedi:6,implement:[13,21],includ:[1,13,33],index:[26,32,33],info:[13,23],inform:[13,23,33],initi:[5,28,31],inject:32,input:[17,32],instal:[6,12,26,27,28,31,32],instanc:[15,21],instance_typ:21,interact:17,intern:21,introduc:32,invalid:16,investig:13,is_value_token_opt:16,isol:13,issus:13,its:[6,13],join:32,json:[7,8,16,32,33],keep:13,kei:33,key_typ:16,keyword:17,known:16,kwarg:17,languag:[27,31],larger:13,last:17,launch:33,learn:[29,30,33],len:32,length:[17,26,32],letter:32,level:23,lib:33,librari:[1,5,6,7,8,28,29,30,31],licens:32,lifetim:21,like:[13,32],line:[13,17,32],list:[3,6,12,16,17,21,24,26],live:33,load:15,local:[26,28,31],log:[14,24,31],logfil:23,logger:[21,23,24],logger_abc:[14,24,31],logger_servic:[14,31],loggerabc:[23,24],logging_level_enum:[14,31],logging_set:[14,31],logging_settings_name_enum:[14,31],logginglevelenum:23,loggingset:23,loggingsettingsnameenum:23,login:24,look:32,love:13,lower:[26,32],magenta:17,mail:[14,31],mail_set:24,main:[15,32],maintain:13,major:13,make:[13,33],manag:13,master:13,mayb:13,meant:[29,30],member:13,menu:[17,28,31],messag:[3,17,23],method:13,might:13,mind:13,minim:13,mit:13,more:[13,33],most:[6,32,33],msg_len:17,must:[0,1,6,13],name:[0,1,2,5,6,7,8,16,22,23,26,33],navig:33,need:[13,32,33],next:[17,28,31],none:[16,17,21,23,24,26],note:13,object:[15,16,17,21,24,26],occur:16,off:23,often:13,on_blu:17,on_cyan:17,on_default:17,on_green:17,on_grei:17,on_magenta:17,on_r:17,on_whit:17,on_yellow:17,one:13,onli:32,open:[13,32,33],option:[6,13,16,17,21,23,24,26,32],option_background_color:17,option_foreground_color:17,optionalsarg:6,order:13,org:[19,20],origin:13,otherwis:0,ouput:32,our:13,out:[13,32,33],outdat:26,outlin:13,output:[1,6,7,16,17,32,33],outsid:13,overview:[27,31,33],own:6,packag:[4,5,6,10,12,26,28,29,30,31,32],page:29,parent:6,password:32,patch:13,path:[0,1,7,16,22,23,27,31,33],pep:13,pip:[4,10,12,14,31,32,33],place:16,platform:[29,30],pleas:13,point:[13,15,17],port:24,posit:17,possibl:13,prefix:[6,16],prepar:[1,6,7,13,15],prerequisit:[28,31],press:33,prevent:13,print:[17,32],problem:13,proce:13,process:13,product:22,program:23,project:[0,1,4,6,7,8,10,11,13,27,28,31,33],projectmain:32,prompt:33,properti:[16,17,18,19,20,21,22,23,24,25],propos:13,provid:[13,15,21,32,33],publish:[1,6,8,27,31,33],push:13,pycharm:32,pyhton:33,python:[1,13,26,29,30,32,33],question:13,quickli:13,random:[26,32],random_str:26,rang:32,read:[16,17,32],read_lin:17,readi:[13,33],readili:13,readm:32,realli:13,receiv:24,receiver_list:24,red:17,refer:[0,29,30,31],referenc:0,rel:[27,31],relat:13,remov:[0,6,7,27,31],replac:26,repo:13,repositori:13,repres:[17,18,22,24],represent:[19,20,21,23,24,25],reproduc:13,reproduct:13,requir:13,requiredarg:6,reserv:13,reset:[17,26],reset_cursor_posit:17,reset_execut:26,restart:[6,9,33],result:[24,26],right:13,root:6,run:[1,5,15,17,26,32,33],runtim:22,runtime_directori:22,same:6,sampl:32,save:[13,16,20],save_chang:20,scenario:13,schemat:[27,31],scope:21,search:[13,16,21],search_typ:16,section:32,see:[5,13,19,20,32,33],select:[17,32],send:[13,24],send_mail:24,serv:6,server:[6,24,29,30,33],servic:[2,15,21,23,24,32],service_collect:[14,31],service_collection_abc:[14,31],service_descriptor:[14,31],service_lifetime_enum:[14,31],service_provid:[14,31],service_provider_abc:[14,15,31],service_typ:21,servicecollect:21,servicecollectionabc:21,servicedescriptor:21,servicelifetimeenum:21,serviceprovid:21,serviceproviderabc:[15,21],session:[19,20],set:[2,15,16,17,18,21,22,23,24,25,26,28,31,32],set_background_color:17,set_cursor_posit:17,set_execut:26,set_foreground_color:17,set_hold_back:17,set_runtime_directori:22,set_working_directori:22,setup:[6,7,8,30,33],sh_cpl:[13,33],should:[16,32,33],show:[3,17],shown:[6,16,33],significantli:13,similar:33,simpl:[5,29,30,33],singleton:21,size:13,small:13,snake:26,snake_cas:26,some:6,sometim:13,soon:13,sourc:[0,1,7,8,13,26,32,33],specifi:[0,6,16],spinner:17,spinner_background_color:17,spinner_foreground_color:17,spinner_thread:[14,31],spinnerthread:17,sqlalchemi:[19,20],src:32,stage:22,standard:26,start:[6,27,29,30,31],start_tim:22,startup:15,startup_abc:[14,31],startupabc:15,statement:6,stderr:26,stdout:26,step:13,stop:17,stop_spin:17,store:16,str:[0,1,2,3,4,5,7,8,10,16,17,19,20,22,23,24,26,32],string:[14,17,19,20,23,24,31,32],style:13,subject:24,submodul:[14,31],subprocess:26,success:33,successfulli:13,suppli:6,sure:13,syntax:[27,31],system:26,tabl:[17,26,27,28,31],take:[6,16],target:[0,1],team:13,termin:[6,17,32,33],test:[13,22,32],text:17,text_background_color:17,text_foreground_color:17,than:13,thank:13,them:1,themselv:13,thi:[3,13,15,29,30,32,33],those:33,thread:[2,17],through:32,throughout:13,thrown:23,time:[13,14,23,31],time_format:[23,25],time_format_set:[14,23,31],time_format_settings_names_enum:[14,31],timeformat:25,timeformatset:[23,25],timeformatsettingsnamesenum:25,to_list:16,todai:13,token:16,topic:13,trace:23,traceback:17,tracker:13,transceiv:24,tree:23,tutori:[32,33],type:[0,1,2,3,4,7,8,10,15,16,21,27,31],ultim:13,under:13,understand:[13,29,30,32,33],unfortun:13,uninstal:[6,26,27,31],union:[16,17,21],unit:13,updat:[6,13,27,31],upfront:13,upper:[26,32],url:[26,33],use:[0,6,15,24,29,30,32,33],use_startup:15,used:[1,7,8,15],user:32,user_nam:24,usernam:24,uses:32,util:[14,31],valid:[24,32],valu:[0,1,2,3,4,5,7,8,10,16,17,18,21,22,23,24,25],value_token:16,variabl:[16,26],version:[6,27,31],via:[4,10,13],walk:32,want:[13,32],warn:23,watch:33,wealth:13,welcom:32,well:13,what:[28,31],when:17,whether:16,which:[0,6,16,17,26,33],white:17,who:13,window:33,within:[1,6,13],without:[4,6,13],work:[6,13,22],workaround:13,workflow:[27,31],working_directori:22,workspac:[0,1,5,6,8,28,31],world:[32,33],would:13,write:[13,17,23],write_at:17,write_lin:[17,32],write_line_at:17,yellow:17,you:[0,1,6,13,29,30,32,33],your:[4,6,9,13,29,30,33]},titles:["cpl add","cpl build","cpl generate","cpl help","cpl install","cpl new","CLI Overview and Command Reference","cpl publish","cpl remove","cpl start","cpl uninstall","cpl update","cpl version","Contributing to CPL","API Reference","cpl.application","cpl.configuration","cpl.console","cpl.database","cpl.database.connection","cpl.database.context","cpl.dependency_injection","cpl.environment","cpl.logging","cpl.mailing","cpl.time","cpl.utils","CLI Reference","Getting started","Introduction to the CPL Docs","Introduction to the CPL Docs","cpl","Getting started with CPL","Setting up the local environment and workspace"],titleterms:{"new":5,add:0,address:13,api:14,app:33,applic:15,application_abc:15,application_build:15,application_builder_abc:15,application_environ:22,application_environment_abc:22,argument:[0,2,3,4,8,10],background_color_enum:17,basic:6,bug:13,build:1,cli:[6,27,33],code:13,command:6,configur:16,configuration_abc:16,configuration_model_abc:16,configuration_variable_name_enum:16,connect:19,consol:[17,33],console_argu:16,console_cal:17,content:[0,1,2,4,5,6,7,8,10,32,33],context:20,contribut:13,cpl:[0,1,2,3,4,5,7,8,9,10,11,12,13,15,16,17,18,19,20,21,22,23,24,25,26,29,30,31,32],creat:[32,33],credential_manag:26,databas:[18,19,20],database_connect:19,database_connection_abc:19,database_context:20,database_context_abc:20,database_model:18,database_set:18,database_settings_name_enum:18,dependency_inject:21,descript:[0,1,2,3,4,5,7,8,10],doc:[29,30],email:24,email_client_abc:24,email_client_servic:24,email_client_set:24,email_client_settings_name_enum:24,environ:[22,33],environment_name_enum:22,explor:30,featur:13,feedback:13,foreground_color_enum:17,found:13,gener:2,get:[28,32],guidelin:13,help:3,initi:33,instal:[4,33],introduct:[29,30],issu:13,languag:6,librari:33,licens:13,local:33,log:23,logger_abc:23,logger_servic:23,logging_level_enum:23,logging_set:23,logging_settings_name_enum:23,mail:24,manual:29,menu:32,next:[32,33],overview:6,packag:33,path:6,pip:26,prerequisit:[32,33],project:[5,32],publish:7,pull:13,refer:[6,14,27],rel:6,remov:8,request:13,review:13,rule:13,schemat:[2,6],service_collect:21,service_collection_abc:21,service_descriptor:21,service_lifetime_enum:21,service_provid:21,service_provider_abc:21,set:33,spinner_thread:17,start:[9,28,32,33],startup_abc:15,string:26,submiss:13,submit:13,submodul:18,syntax:6,tabl:[6,32,33],time:25,time_format_set:25,time_format_settings_names_enum:25,type:5,uninstal:10,updat:11,util:26,version:12,what:[32,33],workflow:6,workspac:33}}) \ No newline at end of file diff --git a/docs/build/html/setup.html b/docs/build/html/setup.html new file mode 100644 index 00000000..bf04ce30 --- /dev/null +++ b/docs/build/html/setup.html @@ -0,0 +1,322 @@ + + + + + + + + + + Setting up the local environment and workspace — Common Python Library documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Setting up the local environment and workspace

+ +
+

Prerequisites

+

To get most out of this tutorial you should already have a basic understanding of the following.

+ +

Also you need to have the following installed.

+ +
+
+

Install the package

+

To install the package, open a terminal window and run the following command:

+
pip install sh_cpl --extra-index-url https://pip.sh-edraft.de
+
+
+
+
+

Install the CLI

+

You use the CPL CLI to create projects, generate application and library code. You also use the CLI to build and publish your python packages.

+

To install the CLI, open a terminal window and run the following command:

+
pip install sh_cpl-cli --extra-index-url https://pip.sh-edraft.de
+
+
+
+
+

Create initial console app

+

You develop apps and packages in the context of an CPL project which is defined in an cpl.json.

+
    +

  1. Run the CLI command cpl new console and provide the name my-app, as shown here:

    +
    cpl new console my-app
+
    +
    +
    2. +

  2. The cpl new command prompts you for information about features to include in the initial app. Decline the defaults by enter ‘n’ and press the Enter key.

    3. +
+

The CLI create a new workspace and a simple ‘Hello World’ app, ready to run.

+
+
+

Create initial library

+

You develop apps and packages in the context of an CPL project which is defined in an cpl.json.

+
    +

  1. Run the CLI command cpl new library and provide the name my-lib, as shown here:

    +
    cpl new library my-lib
+
    +
    +
    2. +

  2. The cpl new command prompts you for information about features to include in the initial library. Decline the defaults by enter ‘n’ and press the Enter key.

    3. +
+

The CLI create a new workspace and a simple ‘Hello World’ library with CLI, ready to run.

+
+
+

Start the app

+

The CLI includes a live development server, so that you can run your app locally.

+
    +

  1. Open a terminal window

    2. +

  2. To navigate to your project workspace, run the following command:

    +
    cd /path/to/project/name
+
    +
    +
    3. +

  3. To run the app run:

    +
    cpl start
+
    +
    +
    4. +
+

The cpl start command launches the server, watches your source files, and restarts the app as you make chnages to thoses source files.

+

If your installation and setup was successful, you should see a output similar to the following:

+
Hello World
+
+
+
+
+

What’s next

+
    +

  • To learn more about the CPL CLI, see the CLI Overview

    • +

  • Fore more informations about the Pyhton files generated by cpl new, see New Command

    • +
+ +
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/cli.txt b/docs/cli.txt deleted file mode 100644 index 2c396d12..00000000 --- a/docs/cli.txt +++ /dev/null @@ -1,19 +0,0 @@ -prefix: cpl -commands: - build - - generate: - abc | a - class | c - configmodel | cm - enum | e - service | s - - help - new - console - - start - publish - update - version \ No newline at end of file diff --git a/docs/install.txt b/docs/install.txt deleted file mode 100644 index 54c105b4..00000000 --- a/docs/install.txt +++ /dev/null @@ -1,2 +0,0 @@ -python setup.py install # for install -python setup.py sdist bdist_wheel # for build \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 00000000..6247f7e2 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/pip.txt b/docs/pip.txt deleted file mode 100644 index 90a20272..00000000 --- a/docs/pip.txt +++ /dev/null @@ -1,11 +0,0 @@ -upload: - prod: - twine upload --repository-url https://pip.sh-edraft.de dist/publish/setup/* - twine upload -r pip.sh-edraft.de dist/publish/setup/* - - dev: - twine upload --repository-url https://pip-dev.sh-edraft.de dist/publish/setup/* - twine upload -r pip-dev.sh-edraft.de dist/publish/setup/* - -install: - pip install --extra-index-url https://pip.sh-edraft.de/ sh_cpl diff --git a/docs/source/cli.add.md b/docs/source/cli.add.md new file mode 100644 index 00000000..ebadefbe --- /dev/null +++ b/docs/source/cli.add.md @@ -0,0 +1,25 @@ +# cpl add + +## Contents + +- [Description](#description) +- [Arguments](#arguments) + +Removes a project from workspace. + +cpl **add** *<source-project>* *<target-project>*
+cpl **a** *<source-project>* *<target-project>*
+cpl **A** *<source-project>* *<target-project>* + +## Description + +Adds a project reference to given project. + +If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified. + +## Arguments + +| Argument | Description | Value type | +| ------------------------- |:---------------------------------------------------------------:|:----------------:| +| `````` | Name of the project to which the reference has to be added | ```str``` +| `````` | Name of the project to be referenced | ```str``` diff --git a/docs/source/cli.build.md b/docs/source/cli.build.md new file mode 100644 index 00000000..8fdf31b8 --- /dev/null +++ b/docs/source/cli.build.md @@ -0,0 +1,26 @@ +# cpl build + +## Contents + +- [Description](#description) + + +Copies an python app into an output directory named build/ at the given output path. Must be executed within a CPL workspace or project directory + +cpl **build**
+cpl **b**
+cpl **B** + +## Description + +The command can be used to build a project of type "console" or "library". + +The build command copies all included source files to the output directory. You can run the source files in the output directory directly. + +The command is used to prepare the source files for the publish command or to copy them to an target for execution. + + diff --git a/docs/source/cli.generate.md b/docs/source/cli.generate.md new file mode 100644 index 00000000..8c1748f8 --- /dev/null +++ b/docs/source/cli.generate.md @@ -0,0 +1,35 @@ +# cpl generate + +## Contents + +- [Description](#description) +- [Arguments](#arguments) +- [Schematics](#schematics) + +Generate a file based on schematic. + +cpl **generate** *<schematic>* *<name>*
+cpl **g** *<schematic>* *<name>*
+cpl **G** *<schematic>* *<name>* + +## Description + +Generates files based on a schematic. + +## Arguments + +| Argument | Description | Value type | +| ----------------- |:---------------------------------:|:-------------:| +| `````` | The schematic to generate. | ```str``` | +| `````` | The name of the generated file. | ```str``` | + +## Schematics + +| Schematic | Description | Arguments | +| ----------------- |:-------------------:|:----------------:| +| ```abc``` | Abstract base class | `````` +| ```class``` | Class | `````` +| ```enum``` | Enum class | `````` +| ```service``` | Service class | `````` +| ```settings``` | [Configmodel](cpl.configuration) | `````` +| ```thread``` | Thread class | `````` diff --git a/docs/source/cli.help.md b/docs/source/cli.help.md new file mode 100644 index 00000000..4dec5e74 --- /dev/null +++ b/docs/source/cli.help.md @@ -0,0 +1,22 @@ +# cpl help + + + + +Lists available command and their short descriptions. + +cpl **help** *<command>*
+cpl **h** *<command>*
+cpl **H** *<command>* + +## Description + +Lists available command and their short descriptions. + +## Arguments + +| Argument | Description | Value type | +| ----------------- |:-----------------------------:|:-------------:| +| `````` | Shows a help message for this command in the console. | ```str``` | diff --git a/docs/source/cli.install.md b/docs/source/cli.install.md new file mode 100644 index 00000000..b2eaaa47 --- /dev/null +++ b/docs/source/cli.install.md @@ -0,0 +1,23 @@ +# cpl install + +## Contents + +- [Description](#description) +- [Arguments](#arguments) + +Installs given package via pip + +cpl **install** *<package>*
+cpl **i** *<package>*
+cpl **I** *<package>* + +## Description + +Install given package to project via pip. +Without given package it will install the depedencies of the CPL project your in. + +## Arguments + +| Argument | Description | Value type | +| ----------------- |:-----------------------------:|:-------------:| +| `````` | The package to install | ```str``` | diff --git a/docs/source/cli.new.md b/docs/source/cli.new.md new file mode 100644 index 00000000..b849a09e --- /dev/null +++ b/docs/source/cli.new.md @@ -0,0 +1,31 @@ +# cpl new + +## Contents + +- [Description](#description) +- [Arguments](#arguments) +- [Project types](#project-types) + +Generates a workspace and initial project or add a project to workspace. + +cpl **new** *<type>* *<name>*
+cpl **n** *<type>* *<name>*
+cpl **N** *<type>* *<name>* + +## Description + +Generates a workspace and initial project or add a project to workspace. + +If the command is running in a CPL workspace, it will add the new project to the workspace. + +| Argument | Description | Value type | +| ----------------- |:-----------------------------------------------------:|:-------------:| +| `````` | The type of the project, see [types](#project-types) | ```str``` | +| `````` | The name of the project | ```str``` | + +## Project types + +| Project type | Description | +| ----------------- |:-----------------------------:| +| ```console``` | A simple console application | +| ```library``` | A package | diff --git a/docs/source/cli.overview.md b/docs/source/cli.overview.md new file mode 100644 index 00000000..5cd12eca --- /dev/null +++ b/docs/source/cli.overview.md @@ -0,0 +1,53 @@ +# CLI Overview and Command Reference + +## Table of Contents + +1. [Install CPL](setup#install-the-package) +2. [Install CPL CLI](setup#install-the-cli) +3. [Basic workflow](#basic-workflow) +4. [CLI command-language syntax](#cli-command-language-syntax) +5. [Command overview](#command-overview) + +## Basic workflow + +To create, build, and serve a new, basic CPL project on a development server, go to the parent directory of your new workspace use the following commands: + +```sh +cpl new console my-first-project +cd my-first-project +cpl start +``` + +In the terminal you will the output of the app. + +## CLI command-language syntax + +```cpl``` commandNameOrAlias requiredArg ```[optionalsArgs]``` + +- Most commands, and some options, have aliases. Aliases are shown in the syntax statement for each command. +- Arguments are not prefixed. + +### Relative paths + +Options that specify files can be given as absolute paths, or as paths relative to the current working directory, which is generally either the workspace or project root. + +### Schematics + +The cpl generate command takes as an argument the artifact to be generated. In addition to any general options, each artifact defines its own options in a schematic. Schematic options are supplied to the command in the same format as immediate command options. + +## Command overview + +| Command | Alias | Description | +| ----------------------------- |:-------------:|:----------------:| +| [add](cli.add) | a or a | Adds a project reference to given project. +| [build](cli.build) | b or B | Prepares files for publish into an output directory named dist/ at the given output path. Must be executed from within a workspace directory. +| [generate](cli.generate) | g or G | Generate a new file. +| [help](cli.help) | h or H | Lists available command and their short descriptions. +| [install](cli.install) | i or I | With argument installs packages to project, without argument installs project dependencies. +| [new](cli.new) | n or N | Creates new CPL project. +| [publish](cli.publish) | p or P | Prepares files for publish into an output directory named dist/ at the given output path and executes ```setup.py```. Must be executed from within a library workspace directory. +| [remove](cli.remove) | r or R | Removes a project from workspace. +| [start](cli.start) | s or S | Starts CPL project, restarting on file changes. +| [uninstall](cli.uninstall) | ui or UI | Uninstalls packages from project. +| [update](cli.update) | u or U | Update CPL and project dependencies. +| [version](cli.version) | v or V | Outputs CPL CLI version. diff --git a/docs/source/cli.publish.md b/docs/source/cli.publish.md new file mode 100644 index 00000000..a6c3884a --- /dev/null +++ b/docs/source/cli.publish.md @@ -0,0 +1,27 @@ +# cpl publish + +## Contents + +- [Description](#description) + + +Prepares files for publish into an output directory named dist/ at the given output path and executes ```setup.py```. + +cpl **publish**
+cpl **p**
+cpl **P** + +## Description + +The command can be used to publish a project of type "console" or "library". + +The publish command builds the source files and then creates an ```setup.py``` with data from ```cpl.json```. +The command executes the ```setup.py``` and removes all source files with the ```setup.py``` from the 'publish/' directory. + +Generated files of ```setup.py``` are in the 'publish/setup/' directory. + + \ No newline at end of file diff --git a/docs/source/cli.remove.md b/docs/source/cli.remove.md new file mode 100644 index 00000000..32934904 --- /dev/null +++ b/docs/source/cli.remove.md @@ -0,0 +1,27 @@ +# cpl remove + +## Contents + +- [Description](#description) +- [Arguments](#arguments) + +Removes a project from workspace. + +cpl **remove** *<project>*
+cpl **r** *<project>*
+cpl **R** *<project>* + +## Description + +The command can be used to publish a project of type "console" or "library". + +The publish command builds the source files and then creates an ```setup.py``` with data from ```cpl.json```. +The command executes the ```setup.py``` and removes all source files with the ```setup.py``` from the 'publish/' directory. + +Generated files of ```setup.py``` are in the 'publish/setup/' directory. + +## Arguments + +| Argument | Description | Value type | +| ------------------------- |:-------------------------------------:|:----------------:| +| `````` | The name of the project to delete | ```str``` diff --git a/docs/source/cli.start.md b/docs/source/cli.start.md new file mode 100644 index 00000000..2b067bfb --- /dev/null +++ b/docs/source/cli.start.md @@ -0,0 +1,7 @@ +# cpl start + +Starts your application, restarting on file changes. + +cpl **start**
+cpl **s**
+cpl **S** diff --git a/docs/source/cli.uninstall.md b/docs/source/cli.uninstall.md new file mode 100644 index 00000000..8646615d --- /dev/null +++ b/docs/source/cli.uninstall.md @@ -0,0 +1,22 @@ +# cpl uninstall + +## Contents + +- [Description](#description) +- [Arguments](#arguments) + +Uninstalls given package via pip + +cpl **uninstall** *<package>*
+cpl **ui** *<package>*
+cpl **UI** *<package>* + +## Description + +Uninstall given package from project via pip. + +## Arguments + +| Argument | Description | Value type | +| ----------------- |:-----------------------------:|:-------------:| +| `````` | The package to uninstall | ```str``` | diff --git a/docs/source/cli.update.md b/docs/source/cli.update.md new file mode 100644 index 00000000..586c32c7 --- /dev/null +++ b/docs/source/cli.update.md @@ -0,0 +1,7 @@ +# cpl update + +Updates the CPL and project dependencies. + +cpl **update**
+cpl **u**
+cpl **U** diff --git a/docs/source/cli.version.md b/docs/source/cli.version.md new file mode 100644 index 00000000..4c8fcbe4 --- /dev/null +++ b/docs/source/cli.version.md @@ -0,0 +1,7 @@ +# cpl version + +Lists the version of CPL, CPL CLI and all installed packages from pip. + +cpl **version**
+cpl **v**
+cpl **V** diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 00000000..b4e07d05 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,68 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (ors to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) +import os +import sys +sys.path.insert(0, os.path.abspath('../../src/')) + + +# -- Project information ----------------------------------------------------- + +project = 'Common Python Library' +copyright = '2021, Sven Heidemann' +author = 'Sven Heidemann' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx_rtd_theme', + 'myst_parser' +] + +source_suffix = { + '.rst': 'restructuredtext', + '.txt': 'markdown', + '.md': 'markdown', +} + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [ + 'cpl_cli/templates/*', + 'cpl_cli/*', + 'tests/*' +] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. + +html_theme = 'sphinx_rtd_theme' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] \ No newline at end of file diff --git a/docs/source/contributing.md b/docs/source/contributing.md new file mode 100644 index 00000000..85456726 --- /dev/null +++ b/docs/source/contributing.md @@ -0,0 +1,111 @@ +# Contributing to CPL + +We would love for you to contribute to CPL and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow: + +- [Issuses and Bugs](#found-a-bug) +- [Feature Request](#feature-request) +- [Submission Guidelines](#submission-guidelines) +- [Coding Rules](#coding-rules) +- [License](#license) + +## Found a Bug? + +If you find a bug in the source code, you can help us by [submitting an issue](#submitting-an-issue) to our [Gitea Repository][gitea-repo]. Even better, you can [submit a Pull Request](#submitting-a-pull-request) with a fix. + +## Feature Request + +You can request a new feature by submitting an issue to our [Gitea Repository][gitea-repo]. If you would like to implement a new feature, please consider the size of the change in order to determine the right steps to proceed: + +For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project. + +Note: Adding a new topic to the documentation, or significantly re-writing a topic, counts as a major feature. + +Small Features can be crafted and directly submitted as a [Pull Request](#submit-pr). + +## Submission Guidelines + +### Submitting an Issue + +Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available. + +We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we require that you provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions. + +A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem. + +We require a minimal reproduction to save maintainers' time and ultimately be able to fix more bugs. Often, developers find coding problems themselves while preparing a minimal reproduction. We understand that sometimes it might be hard to extract essential bits of code from a larger codebase but we really need to isolate the problem before we can fix it. + +Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you, we are going to close an issue that doesn't have enough info to be reproduced. + +### Submitting a Pull Request + +Before you submit your Pull Request (PR) consider the following guidelines: + +1. Search the [repository][gitea-repo] for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts. + +2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design upfront helps to ensure that we're ready to accept your work. + +3. Fork the sh-edraft.de/sh_cpl repo. + +4. In your forked repository, make your changes in a new git branch: + + ```sh + git checkout -b my-fix-branch master + ``` + +5. Create your patch, including appropriate test cases. + + + +6. Commit your changes. + + ```sh + git commit --all + ``` + + Note: the optional commit ```-a``` command line option will automatically "add" and "rm" edited files. + +7. Push your branch to the [repository][gitea-repo]: + + ```sh + git push origin my-fix-branch + ``` + +8. In Gitea, send a pull request to sh_cpl:master + +### Reviewing a Pull Request + +The sh-edraft.de team reserves the right not to accept pull requests from community members who haven't been good citizens of the community. Such behavior includes not following the CPL [coding rules](#coding-rules) and applies within or outside of CPL managed channels. + +#### Addressing review feedback + +If we ask for changes via code reviews then: + +1. Make the required updates to the code. + +2. Create a fixup commit and push to your repository (this will update your Pull Request): + + ```sh + git commit --all --fixup HEAD + git push + ``` + +That's it! Thank you for your contribution! + +## Coding Rules + +To ensure consistency throughout the source code, keep these rules in mind as you are working: + +- All features or bug fixes must be tested by one or more unit-tests. + +- All public API methods must be documented. + +- We follow [PEP 8 -- Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/). + +## License + +By contributing, you agree that your contributions will be licensed under its MIT License. +See [LICENSE](https://git.sh-edraft.de/sh-edraft.de/sh_cpl/src/branch/master/LICENSE) + + +[gitea-repo]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl/ +[coding-rules]: / diff --git a/docs/source/cpl.application.rst b/docs/source/cpl.application.rst new file mode 100644 index 00000000..57749fb4 --- /dev/null +++ b/docs/source/cpl.application.rst @@ -0,0 +1,34 @@ +cpl.application +======================= + +cpl.application.application\_abc +--------------------------------------- + +.. automodule:: cpl.application.application_abc + :members: + :undoc-members: + :show-inheritance: + +cpl.application.application\_builder +------------------------------------------- + +.. automodule:: cpl.application.application_builder + :members: + :undoc-members: + :show-inheritance: + +cpl.application.application\_builder\_abc +------------------------------------------------ + +.. automodule:: cpl.application.application_builder_abc + :members: + :undoc-members: + :show-inheritance: + +cpl.application.startup\_abc +----------------------------------- + +.. automodule:: cpl.application.startup_abc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/cpl.configuration.rst b/docs/source/cpl.configuration.rst new file mode 100644 index 00000000..a9c7cc87 --- /dev/null +++ b/docs/source/cpl.configuration.rst @@ -0,0 +1,42 @@ +cpl.configuration +========================= + +cpl.configuration.configuration +-------------------------------------- + +.. automodule:: cpl.configuration.configuration + :members: + :undoc-members: + :show-inheritance: + +cpl.configuration.configuration\_abc +------------------------------------------- + +.. automodule:: cpl.configuration.configuration_abc + :members: + :undoc-members: + :show-inheritance: + +cpl.configuration.configuration\_model\_abc +-------------------------------------------------- + +.. automodule:: cpl.configuration.configuration_model_abc + :members: + :undoc-members: + :show-inheritance: + +cpl.configuration.configuration\_variable\_name\_enum +------------------------------------------------------------ + +.. automodule:: cpl.configuration.configuration_variable_name_enum + :members: + :undoc-members: + :show-inheritance: + +cpl.configuration.console\_argument +------------------------------------------ + +.. automodule:: cpl.configuration.console_argument + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/cpl.console.rst b/docs/source/cpl.console.rst new file mode 100644 index 00000000..ad4c2e8f --- /dev/null +++ b/docs/source/cpl.console.rst @@ -0,0 +1,42 @@ +cpl.console +=================== + +cpl.console.background\_color\_enum +------------------------------------------ + +.. automodule:: cpl.console.background_color_enum + :members: + :undoc-members: + :show-inheritance: + +cpl.console.console +-------------------------- + +.. automodule:: cpl.console.console + :members: + :undoc-members: + :show-inheritance: + +cpl.console.console\_call +-------------------------------- + +.. automodule:: cpl.console.console_call + :members: + :undoc-members: + :show-inheritance: + +cpl.console.foreground\_color\_enum +------------------------------------------ + +.. automodule:: cpl.console.foreground_color_enum + :members: + :undoc-members: + :show-inheritance: + +cpl.console.spinner\_thread +---------------------------------- + +.. automodule:: cpl.console.spinner_thread + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/cpl.database.connection.rst b/docs/source/cpl.database.connection.rst new file mode 100644 index 00000000..1cff3f96 --- /dev/null +++ b/docs/source/cpl.database.connection.rst @@ -0,0 +1,18 @@ +cpl.database.connection +=============================== + +cpl.database.connection.database\_connection +--------------------------------------------------- + +.. automodule:: cpl.database.connection.database_connection + :members: + :undoc-members: + :show-inheritance: + +cpl.database.connection.database\_connection\_abc +-------------------------------------------------------- + +.. automodule:: cpl.database.connection.database_connection_abc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/cpl.database.context.rst b/docs/source/cpl.database.context.rst new file mode 100644 index 00000000..cbfa4901 --- /dev/null +++ b/docs/source/cpl.database.context.rst @@ -0,0 +1,18 @@ +cpl.database.context +============================ + +cpl.database.context.database\_context +--------------------------------------------- + +.. automodule:: cpl.database.context.database_context + :members: + :undoc-members: + :show-inheritance: + +cpl.database.context.database\_context\_abc +-------------------------------------------------- + +.. automodule:: cpl.database.context.database_context_abc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/cpl.database.rst b/docs/source/cpl.database.rst new file mode 100644 index 00000000..b550b32a --- /dev/null +++ b/docs/source/cpl.database.rst @@ -0,0 +1,35 @@ +cpl.database +==================== + +.. toctree:: + :maxdepth: 4 + + cpl.database.connection + cpl.database.context + +Submodules +---------- + +cpl.database.database\_model +----------------------------------- + +.. automodule:: cpl.database.database_model + :members: + :undoc-members: + :show-inheritance: + +cpl.database.database\_settings +-------------------------------------- + +.. automodule:: cpl.database.database_settings + :members: + :undoc-members: + :show-inheritance: + +cpl.database.database\_settings\_name\_enum +-------------------------------------------------- + +.. automodule:: cpl.database.database_settings_name_enum + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/cpl.dependency_injection.rst b/docs/source/cpl.dependency_injection.rst new file mode 100644 index 00000000..11ec1428 --- /dev/null +++ b/docs/source/cpl.dependency_injection.rst @@ -0,0 +1,50 @@ +cpl.dependency\_injection +================================= + +cpl.dependency\_injection.service\_collection +---------------------------------------------------- + +.. automodule:: cpl.dependency_injection.service_collection + :members: + :undoc-members: + :show-inheritance: + +cpl.dependency\_injection.service\_collection\_abc +--------------------------------------------------------- + +.. automodule:: cpl.dependency_injection.service_collection_abc + :members: + :undoc-members: + :show-inheritance: + +cpl.dependency\_injection.service\_descriptor +---------------------------------------------------- + +.. automodule:: cpl.dependency_injection.service_descriptor + :members: + :undoc-members: + :show-inheritance: + +cpl.dependency\_injection.service\_lifetime\_enum +-------------------------------------------------------- + +.. automodule:: cpl.dependency_injection.service_lifetime_enum + :members: + :undoc-members: + :show-inheritance: + +cpl.dependency\_injection.service\_provider +-------------------------------------------------- + +.. automodule:: cpl.dependency_injection.service_provider + :members: + :undoc-members: + :show-inheritance: + +cpl.dependency\_injection.service\_provider\_abc +------------------------------------------------------- + +.. automodule:: cpl.dependency_injection.service_provider_abc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/cpl.environment.rst b/docs/source/cpl.environment.rst new file mode 100644 index 00000000..1bb5bd1c --- /dev/null +++ b/docs/source/cpl.environment.rst @@ -0,0 +1,26 @@ +cpl.environment +======================= + +cpl.environment.application\_environment +----------------------------------------------- + +.. automodule:: cpl.environment.application_environment + :members: + :undoc-members: + :show-inheritance: + +cpl.environment.application\_environment\_abc +---------------------------------------------------- + +.. automodule:: cpl.environment.application_environment_abc + :members: + :undoc-members: + :show-inheritance: + +cpl.environment.environment\_name\_enum +---------------------------------------------- + +.. automodule:: cpl.environment.environment_name_enum + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/cpl.logging.rst b/docs/source/cpl.logging.rst new file mode 100644 index 00000000..aa5880d8 --- /dev/null +++ b/docs/source/cpl.logging.rst @@ -0,0 +1,42 @@ +cpl.logging +=================== + +cpl.logging.logger\_abc +------------------------------ + +.. automodule:: cpl.logging.logger_abc + :members: + :undoc-members: + :show-inheritance: + +cpl.logging.logger\_service +---------------------------------- + +.. automodule:: cpl.logging.logger_service + :members: + :undoc-members: + :show-inheritance: + +cpl.logging.logging\_level\_enum +--------------------------------------- + +.. automodule:: cpl.logging.logging_level_enum + :members: + :undoc-members: + :show-inheritance: + +cpl.logging.logging\_settings +------------------------------------ + +.. automodule:: cpl.logging.logging_settings + :members: + :undoc-members: + :show-inheritance: + +cpl.logging.logging\_settings\_name\_enum +------------------------------------------------ + +.. automodule:: cpl.logging.logging_settings_name_enum + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/cpl.mailing.rst b/docs/source/cpl.mailing.rst new file mode 100644 index 00000000..fb00a96a --- /dev/null +++ b/docs/source/cpl.mailing.rst @@ -0,0 +1,42 @@ +cpl.mailing +=================== + +cpl.mailing.email +------------------------ + +.. automodule:: cpl.mailing.email + :members: + :undoc-members: + :show-inheritance: + +cpl.mailing.email\_client\_abc +------------------------------------- + +.. automodule:: cpl.mailing.email_client_abc + :members: + :undoc-members: + :show-inheritance: + +cpl.mailing.email\_client\_service +----------------------------------------- + +.. automodule:: cpl.mailing.email_client_service + :members: + :undoc-members: + :show-inheritance: + +cpl.mailing.email\_client\_settings +------------------------------------------ + +.. automodule:: cpl.mailing.email_client_settings + :members: + :undoc-members: + :show-inheritance: + +cpl.mailing.email\_client\_settings\_name\_enum +------------------------------------------------------ + +.. automodule:: cpl.mailing.email_client_settings_name_enum + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/cpl.rst b/docs/source/cpl.rst new file mode 100644 index 00000000..bcc31ee0 --- /dev/null +++ b/docs/source/cpl.rst @@ -0,0 +1,16 @@ +API Reference +=========== + +.. toctree:: + :maxdepth: 4 + + cpl.application + cpl.configuration + cpl.console + cpl.database + cpl.dependency_injection + cpl.environment + cpl.logging + cpl.mailing + cpl.time + cpl.utils diff --git a/docs/source/cpl.time.rst b/docs/source/cpl.time.rst new file mode 100644 index 00000000..7389b8a3 --- /dev/null +++ b/docs/source/cpl.time.rst @@ -0,0 +1,18 @@ +cpl.time +================ + +cpl.time.time\_format\_settings +-------------------------------------- + +.. automodule:: cpl.time.time_format_settings + :members: + :undoc-members: + :show-inheritance: + +cpl.time.time\_format\_settings\_names\_enum +--------------------------------------------------- + +.. automodule:: cpl.time.time_format_settings_names_enum + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/cpl.utils.rst b/docs/source/cpl.utils.rst new file mode 100644 index 00000000..4ccbfcf6 --- /dev/null +++ b/docs/source/cpl.utils.rst @@ -0,0 +1,26 @@ +cpl.utils +================= + +cpl.utils.credential\_manager +------------------------------------ + +.. automodule:: cpl.utils.credential_manager + :members: + :undoc-members: + :show-inheritance: + +cpl.utils.pip +-------------------- + +.. automodule:: cpl.utils.pip + :members: + :undoc-members: + :show-inheritance: + +cpl.utils.string +----------------------- + +.. automodule:: cpl.utils.string + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/cpl_cli.rst b/docs/source/cpl_cli.rst new file mode 100644 index 00000000..338ba5c2 --- /dev/null +++ b/docs/source/cpl_cli.rst @@ -0,0 +1,19 @@ +CLI Reference +============= + +.. toctree:: + :maxdepth: 4 + + cli.overview + cli.add + cli.build + cli.generate + cli.help + cli.install + cli.new + cli.publish + cli.remove + cli.start + cli.uninstall + cli.update + cli.version \ No newline at end of file diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst new file mode 100644 index 00000000..ee746fb1 --- /dev/null +++ b/docs/source/getting_started.rst @@ -0,0 +1,9 @@ +Getting started +=============== + +.. toctree:: + :maxdepth: 4 + + quickstart + setup + diff --git a/docs/source/images/ide-emulate.png b/docs/source/images/ide-emulate.png new file mode 100644 index 00000000..3c6f5a6b Binary files /dev/null and b/docs/source/images/ide-emulate.png differ diff --git a/docs/source/images/ide-src.png b/docs/source/images/ide-src.png new file mode 100644 index 00000000..f778cd46 Binary files /dev/null and b/docs/source/images/ide-src.png differ diff --git a/docs/source/images/ide.png b/docs/source/images/ide.png new file mode 100644 index 00000000..18370cd8 Binary files /dev/null and b/docs/source/images/ide.png differ diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 00000000..4bf52fab --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,24 @@ +.. Common Python Library documentation master file, created by + sphinx-quickstart on Wed Apr 14 10:25:36 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Introduction to the CPL Docs +============================ + +The Common Python Library (CPL) is a package for python and a development platform meant to help you create simple and efficient server and desktop applications. + +This CPL docs help you learn, understand and use the package. From your first application to complex apps for enterprises. + +Manuals +--------- + +These pages go into great detail about everything the Library can do. + +.. toctree:: + :maxdepth: 1 + + introduction + getting_started + cpl + cpl_cli diff --git a/docs/source/introduction.md b/docs/source/introduction.md new file mode 100644 index 00000000..eb36b40f --- /dev/null +++ b/docs/source/introduction.md @@ -0,0 +1,12 @@ +# Introduction to the CPL Docs + +The Common Python Library (CPL) is a package for python and a development platform meant to help you create simple and efficient server and desktop applications. + +This CPL docs help you learn, understand and use the package. From your first application to complex apps for enterprises. + +## Explore + +- [Getting started](quickstart) +- [Setup](setup) +- [API Reference](cpl) +- [CLI Reference](cli.overview) diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 00000000..962df7d9 --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,9 @@ +cpl +=== + +.. toctree:: + :maxdepth: 4 + + getting_started + cpl + cpl_cli diff --git a/docs/source/quickstart.md b/docs/source/quickstart.md new file mode 100644 index 00000000..0b75384e --- /dev/null +++ b/docs/source/quickstart.md @@ -0,0 +1,210 @@ +# Getting started with CPL + +Welcome to CPL! + +This tutorial introduces you to the essentials of the CPL package by walking through building an console based app. + +## Table of Contents + +1. [Prerequisites](#prerequisites) +2. [Create the project](#create-the-project) +3. [Create a menu](#create-a-menu) +4. [What's next](#whats-next) + +## Prerequisites + +To get most out of this tutorial you should already have a basic understanding of the following. + +- [Python][python] + +Also you need to have the following installed. + +- [Python][python] +- [Pip][pip-url] +- [CPL](setup) +- [CPL-CLI](setup) + +## Create the project + +To create the sample project to the following: + +1. Open a terminal +2. Run + + ```sh + cpl new console sample-project + ``` + +3. We don't want to use Application base or Dependency injection: + + ```sh + Do you want to use application base? (y/n) n + + Do you want to use service providing? (y/n) n + ``` + + The ouput should look like this: + + ```sh + Creating sample-project/LICENSE done + Creating sample-project/README.md done + Creating sample-project/src/tests/__init__.py done + Creating sample-project/appsettings.json done + Creating sample-project/src/sample-project/__init__.py done + Creating sample-project/src/sample-projectmain.py done + ``` + +4. Open the project with an IDE like VS Code or PyCharm + + ![IDE](images/ide.png) + +5. Set the 'src' directory as source folder + + ![IDE set src folder](images/ide-src.png) + +6. Run the application + + You should see an output like: + + ```sh + Hello World + ``` + +7. In PyCharm you have to enable ```Emulate terminal in output console```! + + ![IDE emulate console](images/ide-emulate.png) + +## Create a menu + +1. Open the 'sample-project/main.py' + +2. Change 'Hello World' to 'Password generator:' in line 5 + +3. Add ```Console.select``` as follows: + + ```py + from cpl.console import Console + + + def main(): + Console.write_line('Password generator:') + options = [ + 'Only lower case', + 'Only upper case', + 'Lower and upper case' + 'Exit' + ] + option = Console.select('>', 'Select option: ', options) + + + if __name__ == '__main__': + main() + + ``` + +4. Get Id of the selected option: + + ```py + index = options.index(option) + ``` + +5. Create the generate function as follows: + + ```py + def generate_password(letters: str, length: int) -> str: + return ''.join(random.choice(letters) for i in range(length)) + ``` + + Add imports: + + ```py + import random + import string + ``` + +6. Get length of the password: + + ```py + length = int(Console.read('Length: ')) + ``` + +7. Validate the selected option: + + ```py + index = options.index(option) + letters = '' + + if index == 0: + letters = string.ascii_lowercase + elif index == 1: + letters = string.ascii_uppercase + elif index == 2: + letters = string.ascii_letters + elif index == len(options) - 1: + exit() + ``` + +8. Print the generated password: + + ```py + Console.write_line('Password: ', generate_password(letters, length)) + ``` + +9. The full 'sample-project/main.py': + + ```py + import random + import string + + from cpl.console import Console + + + def generate_password(letters: str, length: int) -> str: + return ''.join(random.choice(letters) for i in range(length)) + + + def main(): + Console.write_line('Password generator:') + options = [ + 'Only lower case', + 'Only upper case', + 'Lower and upper case', + 'Exit' + ] + option = Console.select('>', 'Select option: ', options) + + length = int(Console.read('Length: ')) + + index = options.index(option) + letters = '' + if index == 0: + letters = string.ascii_lowercase + elif index == 1: + letters = string.ascii_uppercase + elif index == 2: + letters = string.ascii_letters + elif index == len(options) - 1: + exit() + + Console.write_line('Password: ', generate_password(letters, length)) + + + if __name__ == '__main__': + main() + + ``` + +## What's next + +In this section, you've created an application that uses user input to generate a password. + +To continue exploring CPL and developing applications: + +- [Application base](cpl.application) +- [Dependency injection](cpl.dependency_injection) +- [Console](cpl.console) + + +[pip-url]: https://pip.sh-edraft.de +[python]: https://www.python.org/ +[pip]: https://pypi.org/project/pip/ diff --git a/docs/source/setup.md b/docs/source/setup.md new file mode 100644 index 00000000..29e6f086 --- /dev/null +++ b/docs/source/setup.md @@ -0,0 +1,104 @@ +# Setting up the local environment and workspace + +## Table of Contents + +1. [Prerequisites](#prerequisites) +2. [Install the package](#install-the-package) +3. [Install the CLI](#install-the-cli) +4. [Create a initial application](#create-initial-console-app) +5. [Create a initial library](#create-initial-library) +6. [Start the application](#start-the-app) +7. [What's next](#whats-next) + +## Prerequisites + +To get most out of this tutorial you should already have a basic understanding of the following. + +- [Python][python] + +Also you need to have the following installed. + +- [Python][python] +- [Pip][pip-url] + +## Install the package + +To install the package, open a terminal window and run the following command: + +```sh +pip install sh_cpl --extra-index-url https://pip.sh-edraft.de +``` + +## Install the CLI + +You use the CPL CLI to create projects, generate application and library code. You also use the CLI to build and publish your python packages. + +To install the CLI, open a terminal window and run the following command: + +```sh +pip install sh_cpl-cli --extra-index-url https://pip.sh-edraft.de +``` + +## Create initial console app + +You develop apps and packages in the context of an CPL project which is defined in an cpl.json. + +1. Run the CLI command ```cpl new console``` and provide the name my-app, as shown here: + + ```sh + cpl new console my-app + ``` + +2. The cpl new command prompts you for information about features to include in the initial app. Decline the defaults by enter 'n' and press the Enter key. + +The CLI create a new workspace and a simple 'Hello World' app, ready to run. + +## Create initial library + +You develop apps and packages in the context of an CPL project which is defined in an cpl.json. + +1. Run the CLI command ```cpl new library``` and provide the name my-lib, as shown here: + + ```sh + cpl new library my-lib + ``` + +2. The cpl new command prompts you for information about features to include in the initial library. Decline the defaults by enter 'n' and press the Enter key. + +The CLI create a new workspace and a simple 'Hello World' library with CLI, ready to run. + +## Start the app + +The CLI includes a live development server, so that you can run your app locally. + +1. Open a terminal window + +2. To navigate to your project workspace, run the following command: + + ```sh + cd /path/to/project/name + ``` + +3. To run the app run: + + ```sh + cpl start + ``` + +The ```cpl start``` command launches the server, watches your source files, and restarts the app as you make chnages to thoses source files. + +If your installation and setup was successful, you should see a output similar to the following: + +```sh +Hello World +``` + +## What's next + +- To learn more about the CPL CLI, see the [CLI Overview](cli.overview) +- Fore more informations about the Pyhton files generated by ```cpl new```, see [New Command](cli.new) + + +[pip-url]: https://pip.sh-edraft.de +[python]: https://www.python.org/ +[pip]: https://pypi.org/project/pip/ diff --git a/notices/pip.txt b/notices/pip.txt new file mode 100644 index 00000000..fddb0076 --- /dev/null +++ b/notices/pip.txt @@ -0,0 +1,39 @@ +upload: + prod: + cpl: + twine upload --repository-url https://pip.sh-edraft.de dist/sh_cpl/publish/setup/* + twine upload -r pip.sh-edraft.de dist/sh_cpl/publish/setup/* + cli: + twine upload --repository-url https://pip.sh-edraft.de dist/sh_cpl-cli/publish/setup/* + twine upload -r pip.sh-edraft.de dist/sh_cpl-cli/publish/setup/* + + exp: + cpl: + twine upload --repository-url https://pip-exp.sh-edraft.de dist/sh_cpl/publish/setup/* + twine upload -r pip-exp.sh-edraft.de dist/sh_cpl/publish/setup/* + + cli: + twine upload --repository-url https://pip-exp.sh-edraft.de dist/sh_cpl-cli/publish/setup/* + twine upload -r pip-exp.sh-edraft.de dist/sh_cpl-cli/publish/setup/* + + dev: + cpl: + twine upload --repository-url https://pip-dev.sh-edraft.de dist/sh_cpl/publish/setup/* + twine upload -r pip-dev.sh-edraft.de dist/sh_cpl/publish/setup/* + + cli: + twine upload --repository-url https://pip-dev.sh-edraft.de dist/sh_cpl-cli/publish/setup/* + twine upload -r pip-dev.sh-edraft.de dist/sh_cpl-cli/publish/setup/* + +install: + prod: + pip install --extra-index-url https://pip.sh-edraft.de/ sh_cpl + pip install --extra-index-url https://pip.sh-edraft.de/ sh_cpl-cli + + exp: + pip install --extra-index-url https://pip-exp.sh-edraft.de/ sh_cpl + pip install --extra-index-url https://pip-exp.sh-edraft.de/ sh_cpl-cli + + dev: + pip install --extra-index-url https://pip-dev.sh-edraft.de/ sh_cpl + pip install --extra-index-url https://pip-dev.sh-edraft.de/ sh_cpl-cli diff --git a/docs/todo.txt b/notices/todo.txt similarity index 100% rename from docs/todo.txt rename to notices/todo.txt diff --git a/scripts/build.sh b/scripts/build.sh new file mode 100644 index 00000000..bccdac52 --- /dev/null +++ b/scripts/build.sh @@ -0,0 +1,11 @@ +#!/bin/bash +# activate venv +source /home/sven/Nextcloud_Sven/Schreibtisch/git_sh-edraft_de/sh_cpl/cpl-env/bin/activate + +# CLI +cd /home/sven/Nextcloud_Sven/Schreibtisch/git_sh-edraft_de/sh_cpl/ +cpl build + +# CPL +cd /home/sven/Nextcloud_Sven/Schreibtisch/git_sh-edraft_de/sh_cpl/src/cpl +cpl build \ No newline at end of file diff --git a/scripts/chrome.sh b/scripts/chrome.sh new file mode 100644 index 00000000..b4f0e1ac --- /dev/null +++ b/scripts/chrome.sh @@ -0,0 +1,3 @@ +#!/bin/bash + +google-chrome $PWD/../docs/build/html/index.html \ No newline at end of file diff --git a/scripts/create_docs.sh b/scripts/create_docs.sh new file mode 100644 index 00000000..e59faeab --- /dev/null +++ b/scripts/create_docs.sh @@ -0,0 +1,6 @@ +#!/bin/bash + +cd ../docs/ +sphinx-apidoc -o source/ ../src/cpl +make clean +make html; \ No newline at end of file diff --git a/scripts/publish.sh b/scripts/publish.sh new file mode 100644 index 00000000..341a279c --- /dev/null +++ b/scripts/publish.sh @@ -0,0 +1,11 @@ +#!/bin/bash +# activate venv +source /home/sven/Nextcloud_Sven/Schreibtisch/git_sh-edraft_de/sh_cpl/cpl-env/bin/activate + +# CLI +cd /home/sven/Nextcloud_Sven/Schreibtisch/git_sh-edraft_de/sh_cpl/ +cpl publish + +# CPL +cd /home/sven/Nextcloud_Sven/Schreibtisch/git_sh-edraft_de/sh_cpl/src/cpl +cpl publish \ No newline at end of file diff --git a/src/cpl/__init__.py b/src/cpl/__init__.py index 2d0005b2..6fd3d314 100644 --- a/src/cpl/__init__.py +++ b/src/cpl/__init__.py @@ -11,15 +11,15 @@ sh-edraft Common Python library """ -__title__ = 'sh_cpl.cpl' +__title__ = 'cpl' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple # imports: VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl/application/__init__.py b/src/cpl/application/__init__.py index 58595598..ed424780 100644 --- a/src/cpl/application/__init__.py +++ b/src/cpl/application/__init__.py @@ -15,7 +15,7 @@ __title__ = 'cpl.application' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple @@ -26,4 +26,4 @@ from .application_builder_abc import ApplicationBuilderABC from .startup_abc import StartupABC VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl/application/application_abc.py b/src/cpl/application/application_abc.py index 4c0e07d8..b7b303bd 100644 --- a/src/cpl/application/application_abc.py +++ b/src/cpl/application/application_abc.py @@ -8,20 +8,26 @@ from cpl.environment import ApplicationEnvironmentABC class ApplicationABC(ABC): + r"""ABC for the Application class + + Parameters + ---------- + config: :class:`cpl.configuration.configuration_abc.ConfigurationABC` + Contains object loaded from appsettings + services: :class:`cpl.dependency_injection.service_provider_abc.ServiceProviderABC` + Contains instances of prepared objects + """ @abstractmethod def __init__(self, config: ConfigurationABC, services: ServiceProviderABC): - """ - ABC of application - """ self._configuration: Optional[ConfigurationABC] = config self._environment: Optional[ApplicationEnvironmentABC] = self._configuration.environment self._services: Optional[ServiceProviderABC] = services def run(self): - """ - Entry point - :return: + r"""Entry point + + Called by custom Application.main """ try: self.configure() @@ -31,16 +37,16 @@ class ApplicationABC(ABC): @abstractmethod def configure(self): - """ - Prepare the application - :return: + r"""Configure the application + + Called by :class:`cpl.application.application_abc.ApplicationABC.run` """ pass @abstractmethod def main(self): - """ - Custom entry point - :return: + r"""Custom entry point + + Called by :class:`cpl.application.application_abc.ApplicationABC.run` """ pass diff --git a/src/cpl/application/application_builder.py b/src/cpl/application/application_builder.py index 1dd7355d..e16b2573 100644 --- a/src/cpl/application/application_builder.py +++ b/src/cpl/application/application_builder.py @@ -8,11 +8,15 @@ from cpl.dependency_injection.service_collection import ServiceCollection class ApplicationBuilder(ApplicationBuilderABC): + r"""This is class is used to build a object of :class:`cpl.application.application_abc.ApplicationABC` + + Parameter + --------- + app: Type[:class:`cpl.application.application_abc.ApplicationABC`] + Application to build + """ def __init__(self, app: Type[ApplicationABC]): - """ - Builder class for application - """ ApplicationBuilderABC.__init__(self) self._app = app self._startup: Optional[StartupABC] = None @@ -22,18 +26,9 @@ class ApplicationBuilder(ApplicationBuilderABC): self._services = ServiceCollection(self._configuration) def use_startup(self, startup: Type[StartupABC]): - """ - Sets the used startup class - :param startup: - :return: - """ self._startup = startup(self._configuration, self._services) def build(self) -> ApplicationABC: - """ - Creates application host and runtime - :return: - """ if self._startup is not None: self._startup.configure_configuration() self._startup.configure_services() diff --git a/src/cpl/application/application_builder_abc.py b/src/cpl/application/application_builder_abc.py index b4e7d0d4..13c0e2d3 100644 --- a/src/cpl/application/application_builder_abc.py +++ b/src/cpl/application/application_builder_abc.py @@ -6,25 +6,29 @@ from cpl.application.startup_abc import StartupABC class ApplicationBuilderABC(ABC): + r"""ABC for the :class:`cpl.application.application_builder.ApplicationBuilder`""" + @abstractmethod def __init__(self, *args): - """ - ABC of application builder - """ + pass @abstractmethod def use_startup(self, startup: Type[StartupABC]): - """ - Sets the used startup class - :param startup: - :return: + r"""Sets the custom startup class to use + + Parameter + --------- + startup: Type[:class:`cpl.application.startup_abc.StartupABC`] + Startup class to use """ pass @abstractmethod def build(self) -> ApplicationABC: - """ - Creates application host and runtime - :return: + r"""Creates custom application object + + Returns + ------- + Object of :class:`cpl.application.application_abc.ApplicationABC` """ pass diff --git a/src/cpl/application/startup_abc.py b/src/cpl/application/startup_abc.py index 203adebf..b550854d 100644 --- a/src/cpl/application/startup_abc.py +++ b/src/cpl/application/startup_abc.py @@ -5,25 +5,28 @@ from cpl.dependency_injection.service_provider_abc import ServiceProviderABC class StartupABC(ABC): + r"""ABC for the startup class""" @abstractmethod def __init__(self, *args): - """ - ABC for a startup class - """ + pass @abstractmethod def configure_configuration(self) -> ConfigurationABC: - """ - Creates configuration of application - :return: configuration + r"""Creates configuration of application + + Returns + ------- + Object of :class:`cpl.configuration.configuration_abc.ConfigurationABC` """ pass @abstractmethod def configure_services(self) -> ServiceProviderABC: - """ - Creates service provider - :return: service provider + r"""Creates service provider + + Returns + ------- + Object of :class:`cpl.dependency_injection.service_provider_abc.ServiceProviderABC` """ pass diff --git a/src/cpl/configuration/__init__.py b/src/cpl/configuration/__init__.py index 73693042..f809a40c 100644 --- a/src/cpl/configuration/__init__.py +++ b/src/cpl/configuration/__init__.py @@ -15,7 +15,7 @@ __title__ = 'cpl.configuration' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple @@ -27,4 +27,4 @@ from .configuration_variable_name_enum import ConfigurationVariableNameEnum from .console_argument import ConsoleArgument VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl/configuration/configuration.py b/src/cpl/configuration/configuration.py index 55e35a4f..68e671a6 100644 --- a/src/cpl/configuration/configuration.py +++ b/src/cpl/configuration/configuration.py @@ -18,9 +18,7 @@ from cpl.environment.environment_name_enum import EnvironmentNameEnum class Configuration(ConfigurationABC): def __init__(self): - """ - Representation of configuration - """ + r"""Representation of configuration""" ConfigurationABC.__init__(self) self._application_environment = ApplicationEnvironment() @@ -51,11 +49,14 @@ class Configuration(ConfigurationABC): @staticmethod def _print_info(name: str, message: str): - """ - Prints an info message - :param name: - :param message: - :return: + r"""Prints an info message + + Parameter + --------- + name: :class:`str` + Info name + message: :class:`str` + Info message """ Console.set_foreground_color(ForegroundColorEnum.green) Console.write_line(f'[{name}] {message}') @@ -63,11 +64,14 @@ class Configuration(ConfigurationABC): @staticmethod def _print_warn(name: str, message: str): - """ - Prints a warning - :param name: - :param message: - :return: + r"""Prints a warning + + Parameter + --------- + name: :class:`str` + Warning name + message: :class:`str` + Warning message """ Console.set_foreground_color(ForegroundColorEnum.yellow) Console.write_line(f'[{name}] {message}') @@ -75,22 +79,28 @@ class Configuration(ConfigurationABC): @staticmethod def _print_error(name: str, message: str): - """ - Prints an error - :param name: - :param message: - :return: + r"""Prints an error + + Parameter + --------- + name: :class:`str` + Error name + message: :class:`str` + Error message """ Console.set_foreground_color(ForegroundColorEnum.red) Console.write_line(f'[{name}] {message}') Console.set_foreground_color(ForegroundColorEnum.default) - def _set_variable(self, name: str, value: str): - """ - Sets variable to given value - :param name: - :param value: - :return: + def _set_variable(self, name: str, value: any): + r"""Sets variable to given value + + Parameter + --------- + name: :class:`str` + Name of the variable + value: :class:`any` + Value of the variable """ if name == ConfigurationVariableNameEnum.environment.value: self._application_environment.environment_name = EnvironmentNameEnum(value) @@ -104,37 +114,26 @@ class Configuration(ConfigurationABC): else: self._config[name] = value - def _validate_argument_child(self, argument: str, argument_type: ConsoleArgument, - next_arguments: Optional[list[str]]) -> bool: - """ - Validates the child arguments of argument - :param argument: - :param argument_type: - :param next_arguments: - :return: - """ - if argument_type.console_arguments is not None and len(argument_type.console_arguments) > 0: - found = False - for child_argument_type in argument_type.console_arguments: - found = self._validate_argument_by_argument_type(argument, child_argument_type, next_arguments) - if found and child_argument_type.name not in self._additional_arguments: - self._additional_arguments.append(child_argument_type.name) - - if not found: - raise Exception(f'Invalid argument: {argument}') - - return found - - return True - def _validate_argument_by_argument_type(self, argument: str, argument_type: ConsoleArgument, next_arguments: list[str] = None) -> bool: - """ - Validate argument by argument type - :param argument: - :param argument_type: - :param next_arguments: - :return: + r"""Validate argument by argument type + + Parameter + --------- + argument: :class:`str` + Command as string + argument_type: :class:`cpl.configuration.console_argument.ConsoleArgument` + Command type as ConsoleArgument + next_arguments: list[:class:`str`] + Following arguments of argument + + Returns + ------- + Object of :class:`bool` + + Raises + ------ + Exception: An error occurred getting an argument for a command """ argument_name = '' value = '' @@ -157,10 +156,16 @@ class Configuration(ConfigurationABC): if argument_type.token != '' and argument.startswith(argument_type.token): # --new=value + if len(argument.split(argument_type.token)[1].split(argument_type.value_token)) == 0: + raise Exception(f'Expected argument for command: {argument}') + argument_name = argument.split(argument_type.token)[1].split(argument_type.value_token)[0] else: # new=value - argument_name = argument.split(argument_type.token)[1] + argument_name = argument.split(argument_type.value_token)[1] + + if argument_name == '': + raise Exception(f'Expected argument for command: {argument_type.name}') result = True @@ -191,7 +196,7 @@ class Configuration(ConfigurationABC): # ?new value found = False for alias in argument_type.aliases: - if alias in argument: + if alias == argument or f' {alias} ' == argument: found = True if argument_type.name not in argument and not found: @@ -199,12 +204,13 @@ class Configuration(ConfigurationABC): if (next_arguments is None or len(next_arguments) == 0) and \ argument_type.is_value_token_optional is not True: - raise Exception(f'Invalid argument: {argument}') + raise Exception(f'Expected argument for command: {argument_type.name}') if (next_arguments is None or len(next_arguments) == 0) and argument_type.is_value_token_optional is True: value = '' else: value = next_arguments[0] + next_arguments.remove(value) self._handled_args.append(value) if argument_type.token != '' and argument.startswith(argument_type.token): @@ -236,10 +242,53 @@ class Configuration(ConfigurationABC): next_args = [] if len(next_arguments) > 1: next_args = next_arguments[1:] - result = self._validate_argument_child(next_arguments[0], argument_type, next_args) + + if argument_type.console_arguments is not None and len(argument_type.console_arguments) > 0: + found_child = False + for child_argument_type in argument_type.console_arguments: + found_child = self._validate_argument_by_argument_type( + next_arguments[0], + child_argument_type, + next_args + ) + if found_child and child_argument_type.name not in self._additional_arguments: + self._additional_arguments.append(child_argument_type.name) + + if found_child: + break + + if not found_child: + result = self._validate_argument_by_argument_type(next_arguments[0], argument_type, next_args) return result + def _load_json_file(self, file: str, output: bool) -> dict: + r"""Reads the json file + + Parameter + --------- + file: :class:`str` + Name of the file + output: :class:`bool` + Specifies whether an output should take place + + Returns + ------- + Object of :class:`dict` + """ + try: + # open config file, create if not exists + with open(file, encoding='utf-8') as cfg: + # load json + json_cfg = json.load(cfg) + if output: + self._print_info(__name__, f'Loaded config file: {file}') + + return json_cfg + except Exception as e: + self._print_error(__name__, f'Cannot load config file: {file}! -> {e}') + return {} + def add_environment_variables(self, prefix: str): for variable in ConfigurationVariableNameEnum.to_list(): var_name = f'{prefix}{variable}' @@ -277,6 +326,7 @@ class Configuration(ConfigurationABC): if not found and error_message == '' and error is not False: error_message = f'Invalid argument: {argument}' + if error_message != '': if self._argument_error_function is not None: self._argument_error_function(error_message) else: @@ -284,15 +334,25 @@ class Configuration(ConfigurationABC): exit() - def add_json_file(self, name: str, optional: bool = None, output: bool = True, path: str = None): - path_root = self._application_environment.content_root_path - if path is not None: - path_root = path + add_args = [] + for next_arg in next_arguments: + if next_arg not in self._handled_args and next_arg not in self._additional_arguments: + add_args.append(next_arg) - if str(path_root).endswith('/') and not name.startswith('/'): - file_path = f'{path_root}{name}' + self._set_variable(f'{argument}AdditionalArguments', add_args) + + def add_json_file(self, name: str, optional: bool = None, output: bool = True, path: str = None): + if os.path.isabs(name): + file_path = name else: - file_path = f'{path_root}/{name}' + path_root = self._application_environment.working_directory + if path is not None: + path_root = path + + if str(path_root).endswith('/') and not name.startswith('/'): + file_path = f'{path_root}{name}' + else: + file_path = f'{path_root}/{name}' if not os.path.isfile(file_path): if optional is not True: @@ -314,31 +374,11 @@ class Configuration(ConfigurationABC): configuration.from_dict(value) self.add_configuration(sub, configuration) - def _load_json_file(self, file: str, output: bool) -> dict: - """ - Reads the json file - :param file: - :param output: - :return: - """ - try: - # open config file, create if not exists - with open(file, encoding='utf-8') as cfg: - # load json - json_cfg = json.load(cfg) - if output: - self._print_info(__name__, f'Loaded config file: {file}') - - return json_cfg - except Exception as e: - self._print_error(__name__, f'Cannot load config file: {file}! -> {e}') - return {} - - def add_configuration(self, key_type: type, value: ConfigurationModelABC): + def add_configuration(self, key_type: Union[str, type], value: ConfigurationModelABC): self._config[key_type] = value - def get_configuration(self, search_type: Union[str, Type[ConfigurationModelABC]]) -> Union[ - str, Callable[ConfigurationModelABC]]: + def get_configuration(self, search_type: Union[str, Type[ConfigurationModelABC]]) -> \ + Union[str, Callable[ConfigurationModelABC]]: if type(search_type) is str: if search_type == ConfigurationVariableNameEnum.environment.value: return self._application_environment.environment_name diff --git a/src/cpl/configuration/configuration_abc.py b/src/cpl/configuration/configuration_abc.py index 2fc03bb5..61498d70 100644 --- a/src/cpl/configuration/configuration_abc.py +++ b/src/cpl/configuration/configuration_abc.py @@ -11,9 +11,7 @@ class ConfigurationABC(ABC): @abstractmethod def __init__(self): - """ - ABC of configuration - """ + r"""ABC for the :class:`cpl.configuration.configuration.Configuration`""" pass @property @@ -34,58 +32,78 @@ class ConfigurationABC(ABC): @abstractmethod def add_environment_variables(self, prefix: str): - """ - Reads the environment variables - :param prefix: - :return: + r"""Reads the environment variables + + Parameter + --------- + prefix: :class:`str` + Prefix of the variables """ pass @abstractmethod def add_console_argument(self, argument: ConsoleArgument): - """ - Adds console argument to known console arguments - :param argument: - :return: + r"""Adds console argument to known console arguments + + Parameter + --------- + argument: :class:`cpl.configuration.console_argument.ConsoleArgument` + Specifies the console argument """ pass @abstractmethod def add_console_arguments(self, error: bool = None): - """ - Reads the console arguments - :param error: defines is invalid argument error will be shown or not - :return: + r"""Reads the console arguments + + Parameter + --------- + error: :class:`bool` + Defines is invalid argument error will be shown or not """ pass @abstractmethod def add_json_file(self, name: str, optional: bool = None, output: bool = True, path: str = None): - """ - Reads and saves settings from given json file - :param name: - :param optional: - :param output: - :param path: - :return: + r"""Reads and saves settings from given json file + + Parameter + --------- + name: :class:`str` + Name of the file + optional: :class:`str` + Specifies whether an error should occur if the file was not found + output: :class:`bool` + Specifies whether an output should take place + path: :class:`str` + Path in which the file should be stored """ pass @abstractmethod - def add_configuration(self, key_type: type, value: object): - """ - Add configuration object - :param key_type: - :param value: - :return: + def add_configuration(self, key_type: Union[str, type], value: Union[str, ConfigurationModelABC]): + r"""Add configuration object + + Parameter + --------- + key_type: Union[:class:`str`, :class:`type`] + Type of the value + value: Union[:class:`str`, :class:`cpl.configuration.configuration_model_abc.ConfigurationModelABC`] + Object of the value """ pass @abstractmethod def get_configuration(self, search_type: Union[str, Type[ConfigurationModelABC]]) -> Union[str, Callable[ConfigurationModelABC]]: - """ - Returns value in configuration by given type - :param search_type: - :return: + r"""Returns value from configuration by given type + + Parameter + --------- + search_type: Union[:class:`str`, Type[:class:`cpl.configuration.configuration_model_abc.ConfigurationModelABC`]] + Type to search for + + Returns + ------- + Object of Union[:class:`str`, Callable[:class:`cpl.configuration.configuration_model_abc.ConfigurationModelABC`]] """ pass diff --git a/src/cpl/configuration/configuration_model_abc.py b/src/cpl/configuration/configuration_model_abc.py index bcc6ab37..8c1e6849 100644 --- a/src/cpl/configuration/configuration_model_abc.py +++ b/src/cpl/configuration/configuration_model_abc.py @@ -5,16 +5,15 @@ class ConfigurationModelABC(ABC): @abstractmethod def __init__(self): - """ - ABC for settings representation - """ + r"""ABC for settings representation""" pass @abstractmethod def from_dict(self, settings: dict): - """ - Converts attributes to dict - :param settings: - :return: + r"""Converts attributes to dict + + Parameter + --------- + settings: :class:`dict` """ pass diff --git a/src/cpl/configuration/console_argument.py b/src/cpl/configuration/console_argument.py index bc8a4e13..807f74ae 100644 --- a/src/cpl/configuration/console_argument.py +++ b/src/cpl/configuration/console_argument.py @@ -8,14 +8,16 @@ class ConsoleArgument: is_value_token_optional: bool = None, console_arguments: list['ConsoleArgument'] = None ): - """ - Representation of an console argument - :param token: - :param name: - :param aliases: - :param value_token: - :param is_value_token_optional: - :param console_arguments: + r"""Representation of an console argument + + Parameter + --------- + token: :class:`str` + name: :class:`str` + aliases: list[:class:`str`] + value_token: :class:`str` + is_value_token_optional: :class:`bool` + console_arguments: List[:class:`cpl.configuration.console_argument.ConsoleArgument`] """ self._token = token self._name = name diff --git a/src/cpl/console/__init__.py b/src/cpl/console/__init__.py index b43b7224..f3207a24 100644 --- a/src/cpl/console/__init__.py +++ b/src/cpl/console/__init__.py @@ -15,7 +15,7 @@ __title__ = 'cpl.console' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple @@ -27,4 +27,4 @@ from .foreground_color_enum import ForegroundColorEnum from .spinner_thread import SpinnerThread VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl/console/console.py b/src/cpl/console/console.py index b1536b60..66140873 100644 --- a/src/cpl/console/console.py +++ b/src/cpl/console/console.py @@ -18,9 +18,7 @@ from cpl.console.spinner_thread import SpinnerThread class Console: - """ - Useful functions for handling with input and output - """ + r"""Useful functions for handling with input and output""" colorama.init() _is_first_write = True @@ -42,9 +40,7 @@ class Console: _selected_menu_cursor_foreground_color: ForegroundColorEnum = ForegroundColorEnum.default _selected_menu_cursor_background_color: BackgroundColorEnum = BackgroundColorEnum.default - """ - Properties - """ + """Properties""" @classmethod @property @@ -56,9 +52,7 @@ class Console: def foreground_color(cls) -> str: return str(cls._foreground_color.value) - """ - Settings - """ + """Settings""" @classmethod def set_hold_back(cls, value: bool): @@ -66,10 +60,12 @@ class Console: @classmethod def set_background_color(cls, color: Union[BackgroundColorEnum, str]): - """ - Sets the background color - :param color: - :return: + r"""Sets the background color + + Parameter + --------- + color: Union[:class:`cpl.console.background_color_enum.BackgroundColorEnum`, :class:`str`] + Background color of the console """ if type(color) is str: cls._background_color = BackgroundColorEnum[color] @@ -78,10 +74,12 @@ class Console: @classmethod def set_foreground_color(cls, color: Union[ForegroundColorEnum, str]): - """ - Sets the foreground color - :param color: - :return: + r"""Sets the foreground color + + Parameter + --------- + color: Union[:class:`cpl.console.background_color_enum.BackgroundColorEnum`, :class:`str`] + Foreground color of the console """ if type(color) is str: cls._foreground_color = ForegroundColorEnum[color] @@ -90,37 +88,40 @@ class Console: @classmethod def reset_cursor_position(cls): - """ - Resets cursor position - :return: - """ + r"""Resets cursor position""" cls._x = None cls._y = None @classmethod def set_cursor_position(cls, x: int, y: int): - """ - Sets cursor position - :param x: - :param y: - :return: + r"""Sets cursor position + + Parameter + --------- + x: :class:`int` + X coordinate + y: :class:`int` + Y coordinate """ cls._x = x cls._y = y - """ - Useful protected methods - """ + """Useful protected functions""" @classmethod def _output(cls, string: str, x: int = None, y: int = None, end: str = None): - """ - Prints given output with given format - :param string: - :param x: - :param y: - :param end: - :return: + r"""Prints given output with given format + + Parameter + --------- + string: :class:`str` + Message to print + x: :class:`int` + X coordinate + y: :class:`int` + Y coordinate + end: :class:`str` + End character of the message (could be \n) """ if cls._is_first_write: cls._is_first_write = False @@ -149,10 +150,7 @@ class Console: @classmethod def _show_select_menu(cls): - """ - Shows the select menu - :return: - """ + r"""Shows the select menu""" if not cls._is_first_select_menu_output: for _ in range(0, len(cls._select_menu_items) + 1): sys.stdout.write('\x1b[1A\x1b[2K') @@ -176,10 +174,12 @@ class Console: @classmethod def _select_menu_key_press(cls, key: Key): - """ - Event function when key press is detected - :param key: - :return: + r"""Event function when key press is detected + + Parameter + --------- + key: :class:`pynput.keyboard.Key` + Pressed key """ if key == Key.down: if cls._selected_menu_item_index == len(cls._select_menu_items) - 1: @@ -196,16 +196,16 @@ class Console: elif key == Key.enter: return False - """ - Useful public methods - """ + """ Useful public functions""" @classmethod def banner(cls, string: str): - """ - Prints the string as a banner - :param string: - :return: + r"""Prints the string as a banner + + Parameter + --------- + string: :class:`str` + Message to print as banner """ if cls._disabled: return @@ -219,19 +219,13 @@ class Console: @classmethod def color_reset(cls): - """ - Resets color - :return: - """ + r"""Resets the color settings""" cls._background_color = BackgroundColorEnum.default cls._foreground_color = ForegroundColorEnum.default @classmethod def clear(cls): - """ - Clears the console - :return: - """ + r"""Clears the console""" if cls._hold_back: cls._hold_back_calls.append(ConsoleCall(cls.clear)) return @@ -240,10 +234,7 @@ class Console: @classmethod def close(cls): - """ - Close the application - :return: - """ + r"""Closes the application""" if cls._disabled: return @@ -258,19 +249,19 @@ class Console: @classmethod def disable(cls): - """ - Disable console interaction - :return: - """ + r"""Disables console interaction""" cls._disabled = True @classmethod def error(cls, string: str, tb: str = None): - """ - Prints an error with traceback - :param string: - :param tb: - :return: + r"""Prints an error with traceback + + Parameter + --------- + string: :class:`str` + Error message + tb: :class:`str` + Error traceback """ if cls._disabled: return @@ -288,18 +279,21 @@ class Console: @classmethod def enable(cls): - """ - Enable console interaction - :return: - """ + r"""Enables console interaction""" cls._disabled = False @classmethod def read(cls, output: str = None) -> str: - """ - Read in line - :param output: - :return: + r"""Reads in line + + Parameter + --------- + output: :class:`str` + String to print before input + + Returns + ------- + input() """ if output is not None and not cls._hold_back: cls.write_line(output) @@ -308,10 +302,16 @@ class Console: @classmethod def read_line(cls, output: str = None) -> str: - """ - Reads in next line - :param output: - :return: + r"""Reads in next line + + Parameter + --------- + output: :class:`str` + String to print before input + + Returns + ------- + input() """ if cls._disabled and not cls._hold_back: return '' @@ -325,11 +325,14 @@ class Console: @classmethod def table(cls, header: list[str], values: list[list[str]]): - """ - Prints a table with header and values - :param header: - :param values: - :return: + r"""Prints a table with header and values + + Parameter + --------- + header: List[:class:`str`] + Header of the table + values: List[List[:class:`str`]] + Values of the table """ if cls._disabled: return @@ -352,18 +355,32 @@ class Console: cursor_foreground_color: Union[str, ForegroundColorEnum] = ForegroundColorEnum.default, cursor_background_color: Union[str, BackgroundColorEnum] = BackgroundColorEnum.default ) -> str: - """ - Prints select menu - :param char: - :param message: - :param options: - :param header_foreground_color: - :param header_background_color: - :param option_foreground_color: - :param option_background_color: - :param cursor_foreground_color: - :param cursor_background_color: - :return: Selected option as str + r"""Prints select menu + + Parameter + --------- + char: :class:`str` + Character to show which element is selected + message: :class:`str` + Message or header of the selection + options: List[:class:`str`] + Selectable options + header_foreground_color: Union[:class:`str`, :class:`cpl.console.foreground_color_enum.ForegroundColorEnum`] + Foreground color of the header + header_background_color: Union[:class:`str`, :class:`cpl.console.background_color_enum.BackgroundColorEnum`] + Background color of the header + option_foreground_color: Union[:class:`str`, :class:`cpl.console.foreground_color_enum.ForegroundColorEnum`] + Foreground color of the options + option_background_color: Union[:class:`str`, :class:`cpl.console.background_color_enum.BackgroundColorEnum`] + Background color of the options + cursor_foreground_color: Union[:class:`str`, :class:`cpl.console.foreground_color_enum.ForegroundColorEnum`] + Foreground color of the cursor + cursor_background_color: Union[:class:`str`, :class:`cpl.console.background_color_enum.BackgroundColorEnum`] + Background color of the cursor + + Returns + ------- + Selected option as :class:`str` """ cls._selected_menu_item_char = char cls.options = options @@ -396,18 +413,30 @@ class Console: spinner_foreground_color: Union[str, ForegroundColorEnum] = None, text_background_color: Union[str, BackgroundColorEnum] = None, spinner_background_color: Union[str, BackgroundColorEnum] = None, **kwargs) -> any: - """ - Shows spinner and calls given function - When function has ended the spinner stops - :param message: - :param call: - :param args: - :param text_foreground_color: - :param spinner_foreground_color: - :param text_background_color: - :param spinner_background_color: - :param kwargs: - :return: Return value of call + r"""Shows spinner and calls given function, when function has ended the spinner stops + + Parameter + --------- + message: :class:`str` + Message of the spinner + call: :class:`Callable` + Function to call + args: :class:`list` + Arguments of the function + text_foreground_color: Union[:class:`str`, :class:`cpl.console.foreground_color_enum.ForegroundColorEnum`] + Foreground color of the text + spinner_foreground_color: Union[:class:`str`, :class:`cpl.console.foreground_color_enum.ForegroundColorEnum`] + Foreground color of the spinner + text_background_color: Union[:class:`str`, :class:`cpl.console.background_color_enum.BackgroundColorEnum`] + Background color of the text + spinner_background_color: Union[:class:`str`, :class:`cpl.console.background_color_enum.BackgroundColorEnum`] + Background color of the spinner + kwargs: :class:`dict` + Keyword arguments of the call + + Returns + ------- + Return value of call """ if cls._hold_back: cls._hold_back_calls.append(ConsoleCall(cls.spinner, message, call, *args)) @@ -446,17 +475,22 @@ class Console: for call in cls._hold_back_calls: call.function(*call.args) + cls._hold_back_calls = [] + time.sleep(0.1) return return_value @classmethod def write(cls, *args, end=''): - """ - Prints in active line - :param args: - :param end: - :return: + r"""Prints in active line + + Parameter + --------- + args: :class:`list` + Elements to print + end: :class:`str` + Last character to print """ if cls._disabled: return @@ -470,12 +504,16 @@ class Console: @classmethod def write_at(cls, x: int, y: int, *args): - """ - Prints at given position - :param x: - :param y: - :param args: - :return: + r"""Prints at given position + + Parameter + --------- + x: :class:`int` + X coordinate + y: :class:`int` + Y coordinate + args: :class:`list` + Elements to print """ if cls._disabled: return @@ -489,10 +527,12 @@ class Console: @classmethod def write_line(cls, *args): - """ - Prints to new line - :param args: - :return: + r"""Prints to new line + + Parameter + --------- + args: :class:`list` + Elements to print """ if cls._disabled: return @@ -508,12 +548,16 @@ class Console: @classmethod def write_line_at(cls, x: int, y: int, *args): - """ - Prints new line at given position - :param x: - :param y: - :param args: - :return: + r"""Prints new line at given position + + Parameter + --------- + x: :class:`int` + X coordinate + y: :class:`int` + Y coordinate + args: :class:`list` + Elements to print """ if cls._disabled: return diff --git a/src/cpl/console/console_call.py b/src/cpl/console/console_call.py index 1a8c10f8..7680a880 100644 --- a/src/cpl/console/console_call.py +++ b/src/cpl/console/console_call.py @@ -2,13 +2,17 @@ from collections import Callable class ConsoleCall: + r"""Represents a console call, for hold back when spinner is active + + Parameter + --------- + function: :class:`Callable` + Function to call + args: :class:`list` + List of arguments + """ def __init__(self, function: Callable, *args): - """ - Represents a console call, for hold back when spinner is active - :param function: - :param args: - """ self._func = function self._args = args diff --git a/src/cpl/console/spinner_thread.py b/src/cpl/console/spinner_thread.py index 7b13d963..e20b431a 100644 --- a/src/cpl/console/spinner_thread.py +++ b/src/cpl/console/spinner_thread.py @@ -10,14 +10,19 @@ from cpl.console.foreground_color_enum import ForegroundColorEnum class SpinnerThread(threading.Thread): + r"""Thread to show spinner in terminal + + Parameter + --------- + msg_len: :class:`int` + Length of the message + foreground_color: :class:`cpl.console.foreground_color.ForegroundColorEnum` + Foreground color of the spinner + background_color: :class:`cpl.console.background_color.BackgroundColorEnum` + Background color of the spinner + """ def __init__(self, msg_len: int, foreground_color: ForegroundColorEnum, background_color: BackgroundColorEnum): - """ - Thread to show spinner in terminal - :param msg_len: - :param foreground_color: - :param background_color: - """ threading.Thread.__init__(self) self._msg_len = msg_len @@ -29,19 +34,13 @@ class SpinnerThread(threading.Thread): @staticmethod def _spinner(): - """ - Selects active spinner char - :return: - """ + r"""Selects active spinner char""" while True: for cursor in '|/-\\': yield cursor def _get_color_args(self) -> list[str]: - """ - Creates color arguments - :return: - """ + r"""Creates color arguments""" color_args = [] if self._foreground_color is not None: color_args.append(str(self._foreground_color.value)) @@ -52,10 +51,7 @@ class SpinnerThread(threading.Thread): return color_args def run(self) -> None: - """ - Entry point of thread, shows the spinner - :return: - """ + r"""Entry point of thread, shows the spinner""" columns = 0 if sys.platform == 'win32': columns = os.get_terminal_size().columns @@ -90,18 +86,12 @@ class SpinnerThread(threading.Thread): print(colored(end_msg, *self._get_color_args()), end='') def stop_spinning(self): - """ - Stops the spinner - :return: - """ + r"""Stops the spinner""" self._is_spinning = False time.sleep(0.1) def exit(self): - """ - Stops the spinner - :return: - """ + r"""Stops the spinner""" self._is_spinning = False self._exit = True time.sleep(0.1) diff --git a/cpl.json b/src/cpl/cpl.json similarity index 79% rename from cpl.json rename to src/cpl/cpl.json index 6fc6ba4b..01eb8038 100644 --- a/cpl.json +++ b/src/cpl/cpl.json @@ -3,8 +3,8 @@ "Name": "sh_cpl", "Version": { "Major": "2021", - "Minor": "04", - "Micro": "0" + "Minor": "4", + "Micro": "0.post1" }, "Author": "Sven Heidemann", "AuthorEmail": "sven.heidemann@sh-edraft.de", @@ -22,8 +22,8 @@ "packaging==20.9", "pyfiglet==0.8.post1", "pynput==1.7.3", - "SQLAlchemy==1.4.3", - "setuptools==54.2.0", + "SQLAlchemy==1.4.7", + "setuptools==56.0.0", "tabulate==0.8.9", "termcolor==1.1.0", "watchdog==2.0.2", @@ -35,10 +35,10 @@ }, "BuildSettings": { "ProjectType": "library", - "SourcePath": "src", - "OutputPath": "dist", - "Main": "cpl_cli.main", - "EntryPoint": "cpl", + "SourcePath": "", + "OutputPath": "../../dist", + "Main": "", + "EntryPoint": "", "IncludePackageData": true, "Included": [ "*/templates" @@ -48,10 +48,7 @@ "*/logs", "*/tests" ], - "PackageData": { - "cpl_cli": [ - "*.json" - ] - } + "PackageData": {}, + "ProjectReferences": [] } } \ No newline at end of file diff --git a/src/cpl/database/__init__.py b/src/cpl/database/__init__.py index 307c43a4..905a677e 100644 --- a/src/cpl/database/__init__.py +++ b/src/cpl/database/__init__.py @@ -15,7 +15,7 @@ __title__ = 'cpl.database' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple @@ -25,4 +25,4 @@ from .database_settings import DatabaseSettings from .database_settings_name_enum import DatabaseSettingsNameEnum VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl/database/connection/__init__.py b/src/cpl/database/connection/__init__.py index 959b5143..fa73edb7 100644 --- a/src/cpl/database/connection/__init__.py +++ b/src/cpl/database/connection/__init__.py @@ -15,7 +15,7 @@ __title__ = 'cpl.database.connection' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple @@ -24,4 +24,4 @@ from .database_connection import DatabaseConnection from .database_connection_abc import DatabaseConnectionABC VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl/database/connection/database_connection.py b/src/cpl/database/connection/database_connection.py index 87f77758..551ce238 100644 --- a/src/cpl/database/connection/database_connection.py +++ b/src/cpl/database/connection/database_connection.py @@ -10,12 +10,14 @@ from cpl.database.database_settings import DatabaseSettings class DatabaseConnection(DatabaseConnectionABC): + r"""Representation of the database connection + + Parameter + --------- + database_settings: :class:`cpl.database.database_settings.DatabaseSettings` + """ def __init__(self, database_settings: DatabaseSettings): - """ - Represents an connection to a database - :param database_settings: - """ DatabaseConnectionABC.__init__(self) self._db_settings = database_settings diff --git a/src/cpl/database/connection/database_connection_abc.py b/src/cpl/database/connection/database_connection_abc.py index 139e9214..637c1da7 100644 --- a/src/cpl/database/connection/database_connection_abc.py +++ b/src/cpl/database/connection/database_connection_abc.py @@ -5,6 +5,7 @@ from sqlalchemy.orm import Session class DatabaseConnectionABC(ABC): + r"""ABC for the :class:`cpl.database.connection.database_connection.DatabaseConnection`""" @abstractmethod def __init__(self): pass @@ -19,9 +20,11 @@ class DatabaseConnectionABC(ABC): @abstractmethod def connect(self, connection_string: str): - """ - Connects to a database by connection string - :param connection_string: - :return: + r"""Connects to a database by connection string + + Parameter + --------- + connection_string: :class:`str` + Database connection string, see: https://docs.sqlalchemy.org/en/14/core/engines.html """ pass diff --git a/src/cpl/database/context/__init__.py b/src/cpl/database/context/__init__.py index 5e9e9607..4144583e 100644 --- a/src/cpl/database/context/__init__.py +++ b/src/cpl/database/context/__init__.py @@ -15,7 +15,7 @@ __title__ = 'cpl.database.context' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple @@ -24,4 +24,4 @@ from .database_context import DatabaseContext from .database_context_abc import DatabaseContextABC VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl/database/context/database_context.py b/src/cpl/database/context/database_context.py index c07f1acd..e331c9e5 100644 --- a/src/cpl/database/context/database_context.py +++ b/src/cpl/database/context/database_context.py @@ -11,6 +11,12 @@ from cpl.database.database_model import DatabaseModel class DatabaseContext(DatabaseContextABC): + r"""Representation of the database context + + Parameter + --------- + database_settings: :class:`cpl.database.database_settings.DatabaseSettings` + """ def __init__(self, database_settings: DatabaseSettings): DatabaseContextABC.__init__(self) diff --git a/src/cpl/database/context/database_context_abc.py b/src/cpl/database/context/database_context_abc.py index d27d6da0..0587560c 100644 --- a/src/cpl/database/context/database_context_abc.py +++ b/src/cpl/database/context/database_context_abc.py @@ -5,6 +5,7 @@ from sqlalchemy.orm import Session class DatabaseContextABC(ABC): + r"""ABC for the :class:`cpl.database.context.database_context.DatabaseContext`""" @abstractmethod def __init__(self, *args): @@ -20,23 +21,20 @@ class DatabaseContextABC(ABC): @abstractmethod def connect(self, connection_string: str): - """ - Connects to a database with connection string - :param connection_string: - :return: + r"""Connects to a database by connection string + + Parameter + --------- + connection_string: :class:`str` + Database connection string, see: https://docs.sqlalchemy.org/en/14/core/engines.html """ pass def save_changes(self): - """ - Saves changes of the database - """ + r"""Saves changes of the database""" pass @abstractmethod def _create_tables(self): - """ - Create all tables for application from database model - :return: - """ + r"""Create all tables for application from database model""" pass diff --git a/src/cpl/database/database_settings.py b/src/cpl/database/database_settings.py index 130fc78c..08f04b3f 100644 --- a/src/cpl/database/database_settings.py +++ b/src/cpl/database/database_settings.py @@ -8,6 +8,7 @@ from cpl.database.database_settings_name_enum import DatabaseSettingsNameEnum class DatabaseSettings(ConfigurationModelABC): + r"""Represents settings for the database connection""" def __init__(self): ConfigurationModelABC.__init__(self) @@ -68,6 +69,12 @@ class DatabaseSettings(ConfigurationModelABC): self._echo = echo def from_dict(self, settings: dict): + r"""Sets attributes from given dict + + Parameter + --------- + settings: :class:`dict` + """ try: self._connection_string = settings[DatabaseSettingsNameEnum.connection_string.value] self._credentials = settings[DatabaseSettingsNameEnum.credentials.value] diff --git a/src/cpl/dependency_injection/__init__.py b/src/cpl/dependency_injection/__init__.py index eecee040..7f93d971 100644 --- a/src/cpl/dependency_injection/__init__.py +++ b/src/cpl/dependency_injection/__init__.py @@ -15,7 +15,7 @@ __title__ = 'cpl.dependency_injection' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple @@ -28,4 +28,4 @@ from .service_provider import ServiceProvider from .service_provider_abc import ServiceProviderABC VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl/dependency_injection/service_collection.py b/src/cpl/dependency_injection/service_collection.py index 157a012c..5b96e1ff 100644 --- a/src/cpl/dependency_injection/service_collection.py +++ b/src/cpl/dependency_injection/service_collection.py @@ -14,6 +14,7 @@ from cpl.utils.credential_manager import CredentialManager class ServiceCollection(ServiceCollectionABC): + r"""Representation of the collection of services""" def __init__(self, config: ConfigurationABC): ServiceCollectionABC.__init__(self) diff --git a/src/cpl/dependency_injection/service_collection_abc.py b/src/cpl/dependency_injection/service_collection_abc.py index c77ac6b6..4d119b29 100644 --- a/src/cpl/dependency_injection/service_collection_abc.py +++ b/src/cpl/dependency_injection/service_collection_abc.py @@ -8,64 +8,75 @@ from cpl.dependency_injection.service_provider_abc import ServiceProviderABC class ServiceCollectionABC(ABC): + r"""ABC for the class :class:`cpl.dependency_injection.service_collection.ServiceCollection`""" @abstractmethod def __init__(self): - """ - ABC for service providing - """ pass @abstractmethod def add_db_context(self, db_context: Type[DatabaseContextABC], db_settings: DatabaseSettings): - """ - Adds database context - :param db_context: - :param db_settings: - :return: + r"""Adds database context + + Parameter + --------- + db_context: Type[:class:`cpl.database.context.database_context_abc.DatabaseContextABC`] + Database context + db_settings: :class:`cpl.database.database_settings.DatabaseSettings` + Database settings """ pass @abstractmethod def add_logging(self): - """ - Adds the CPL internal logger - """ + r"""Adds the CPL internal logger""" pass @abstractmethod def add_transient(self, service_type: Type, service: Callable = None): - """ - Adds a service with transient lifetime - :param service_type: - :param service: - :return: + r"""Adds a service with transient lifetime + + Parameter + --------- + service_type: :class:`Type` + Type of the service + service: :class:`Callable` + Object of the service """ pass @abstractmethod def add_scoped(self, service_type: Type, service: Callable = None): - """ - Adds a service with scoped lifetime - :param service_type: - :param service: - :return: + r"""Adds a service with scoped lifetime + + Parameter + --------- + service_type: :class:`Type` + Type of the service + service: :class:`Callable` + Object of the service """ pass @abstractmethod def add_singleton(self, service_type: Type, service: Callable = None): - """ - Adds a service with singleton lifetime - :param service_type: - :param service: - :return: + r"""Adds a service with singleton lifetime + + Parameter + --------- + service_type: :class:`Type` + Type of the service + service: :class:`Callable` + Object of the service """ pass @abstractmethod def build_service_provider(self) -> ServiceProviderABC: - """ - Creates instance of the service provider + r"""Creates instance of the service provider + + Returns + ------- + Object of type :class:`cpl.dependency_injection.service_provider_abc.ServiceProviderABC` """ pass diff --git a/src/cpl/dependency_injection/service_descriptor.py b/src/cpl/dependency_injection/service_descriptor.py index 845089ac..a0c70e98 100644 --- a/src/cpl/dependency_injection/service_descriptor.py +++ b/src/cpl/dependency_injection/service_descriptor.py @@ -4,6 +4,15 @@ from cpl.dependency_injection.service_lifetime_enum import ServiceLifetimeEnum class ServiceDescriptor: + r"""Descriptor of a service + + Parameter + --------- + implementation: Union[:class:`type`, Optional[:class:`object`]] + Object or type of service + lifetime: :class:`cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum` + Lifetime of the service + """ def __init__(self, implementation: Union[type, Optional[object]], lifetime: ServiceLifetimeEnum): diff --git a/src/cpl/dependency_injection/service_provider.py b/src/cpl/dependency_injection/service_provider.py index c4c8b2df..c8c333b2 100644 --- a/src/cpl/dependency_injection/service_provider.py +++ b/src/cpl/dependency_injection/service_provider.py @@ -12,6 +12,17 @@ from cpl.environment.application_environment_abc import ApplicationEnvironmentAB class ServiceProvider(ServiceProviderABC): + r"""Provider for the services + + Parameter + --------- + service_descriptors: list[:class:`cpl.dependency_injection.service_descriptor.ServiceDescriptor`] + Descriptor of the service + config: :class:`cpl.configuration.configuration_abc.ConfigurationABC` + CPL Configuration + db_context: Optional[:class:`cpl.database.context.database_context_abc.DatabaseContextABC`] + Database representation + """ def __init__(self, service_descriptors: list[ServiceDescriptor], config: ConfigurationABC, db_context: Optional[DatabaseContextABC]): ServiceProviderABC.__init__(self) diff --git a/src/cpl/dependency_injection/service_provider_abc.py b/src/cpl/dependency_injection/service_provider_abc.py index 042b0355..570035ad 100644 --- a/src/cpl/dependency_injection/service_provider_abc.py +++ b/src/cpl/dependency_injection/service_provider_abc.py @@ -4,28 +4,38 @@ from typing import Type, Optional class ServiceProviderABC(ABC): + r"""ABC for the class :class:`cpl.dependency_injection.service_provider.ServiceProvider`""" @abstractmethod def __init__(self): - """ - ABC for service providing - """ pass @abstractmethod - def build_service(self, service_type: type) -> object: - """ - Creates instance of given type - :param service_type: - :return: + def build_service(self, service_type: Type) -> object: + r"""Creates instance of given type + + Parameter + --------- + instance_type: :class:`Type` + The type of the searched instance + + Returns + ------- + Object of the given type """ pass @abstractmethod def get_service(self, instance_type: Type) -> Optional[Callable[object]]: - """ - Returns instance of given type - :param instance_type: - :return: + r"""Returns instance of given type + + Parameter + --------- + instance_type: :class:`Type` + The type of the searched instance + + Returns + ------- + Object of type Optional[Callable[:class:`object`]] """ pass diff --git a/src/cpl/environment/__init__.py b/src/cpl/environment/__init__.py index 078ab0bc..6809bcde 100644 --- a/src/cpl/environment/__init__.py +++ b/src/cpl/environment/__init__.py @@ -15,7 +15,7 @@ __title__ = 'cpl.environment' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple @@ -25,4 +25,4 @@ from .environment_name_enum import EnvironmentNameEnum from .application_environment import ApplicationEnvironment VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl/environment/application_environment.py b/src/cpl/environment/application_environment.py index 7bb76f13..8acf1637 100644 --- a/src/cpl/environment/application_environment.py +++ b/src/cpl/environment/application_environment.py @@ -1,4 +1,4 @@ -import pathlib +import os from datetime import datetime from socket import gethostname from typing import Optional @@ -8,24 +8,24 @@ from cpl.environment.environment_name_enum import EnvironmentNameEnum class ApplicationEnvironment(ApplicationEnvironmentABC): + r"""Represents environment of the application - def __init__(self, name: EnvironmentNameEnum = EnvironmentNameEnum.production, crp: str = './'): - """ - Represents environment of the application - :param name: - :param crp: - """ + Parameter + --------- + name: :class:`cpl.environment.environment_name_enum.EnvironmentNameEnum` + """ + + def __init__(self, name: EnvironmentNameEnum = EnvironmentNameEnum.production): ApplicationEnvironmentABC.__init__(self) self._environment_name: Optional[EnvironmentNameEnum] = name self._app_name: Optional[str] = None self._customer: Optional[str] = None - self._content_root_path: Optional[str] = crp self._start_time: datetime = datetime.now() self._end_time: datetime = datetime.now() - self._working_directory = pathlib.Path().absolute() - self._runtime_directory = pathlib.Path(__file__).parent.absolute() + self._runtime_directory = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) + self._working_directory = os.getcwd() @property def environment_name(self) -> str: @@ -51,14 +51,6 @@ class ApplicationEnvironment(ApplicationEnvironmentABC): def customer(self, customer: str): self._customer = customer - @property - def content_root_path(self) -> str: - return self._content_root_path - - @content_root_path.setter - def content_root_path(self, content_root_path: str): - self._content_root_path = content_root_path - @property def host_name(self): return gethostname() @@ -81,18 +73,24 @@ class ApplicationEnvironment(ApplicationEnvironmentABC): @property def working_directory(self) -> str: - return self._working_directory - - def set_working_directory(self, path: str = ''): - if path != '': - self._working_directory = path - return - - self._working_directory = pathlib.Path().absolute() + return str(self._working_directory) @property def runtime_directory(self) -> str: - return self._runtime_directory + return str(self._runtime_directory) - def set_runtime_directory(self, file: str): - self._runtime_directory = pathlib.Path(file).parent.absolute() + def set_runtime_directory(self, runtime_directory: str): + if runtime_directory != '': + self._runtime_directory = runtime_directory + return + + self._runtime_directory = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) + + def set_working_directory(self, working_directory: str): + if working_directory != '': + self._working_directory = working_directory + os.chdir(self._working_directory) + return + + self._working_directory = os.path.abspath('./') + os.chdir(self._working_directory) diff --git a/src/cpl/environment/application_environment_abc.py b/src/cpl/environment/application_environment_abc.py index c306f53f..7d0b82c7 100644 --- a/src/cpl/environment/application_environment_abc.py +++ b/src/cpl/environment/application_environment_abc.py @@ -3,12 +3,10 @@ from datetime import datetime class ApplicationEnvironmentABC(ABC): + r"""ABC of the class :class:`cpl.environment.application_environment.ApplicationEnvironment`""" @abstractmethod def __init__(self): - """ - ABC of application environment - """ pass @property @@ -35,14 +33,6 @@ class ApplicationEnvironmentABC(ABC): @abstractmethod def customer(self, customer: str): pass - @property - @abstractmethod - def content_root_path(self) -> str: pass - - @content_root_path.setter - @abstractmethod - def content_root_path(self, content_root_path: str): pass - @property @abstractmethod def host_name(self) -> str: pass @@ -77,9 +67,22 @@ class ApplicationEnvironmentABC(ABC): @abstractmethod def set_runtime_directory(self, runtime_directory: str): - """ - Sets the current runtime directory - :param runtime_directory: - :return: + r"""Sets the current runtime directory + + Parameter + --------- + runtime_directory: :class:`str` + Path of the runtime directory + """ + pass + + @abstractmethod + def set_working_directory(self, working_directory: str): + r"""Sets the current working directory + + Parameter + --------- + working_directory: :class:`str` + Path of the current working directory """ pass diff --git a/src/cpl/logging/__init__.py b/src/cpl/logging/__init__.py index d2fbfadf..404da72b 100644 --- a/src/cpl/logging/__init__.py +++ b/src/cpl/logging/__init__.py @@ -15,7 +15,7 @@ __title__ = 'cpl.logging' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple @@ -27,4 +27,4 @@ from .logging_settings import LoggingSettings from .logging_settings_name_enum import LoggingSettingsNameEnum VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl/logging/logger_abc.py b/src/cpl/logging/logger_abc.py index 98ef4eb9..a6bfa72f 100644 --- a/src/cpl/logging/logger_abc.py +++ b/src/cpl/logging/logger_abc.py @@ -2,81 +2,101 @@ from abc import abstractmethod, ABC class LoggerABC(ABC): + r"""ABC for :class:`cpl.logging.logger_service.Logger`""" @abstractmethod def __init__(self): - """ - ABC for logging - """ ABC.__init__(self) @abstractmethod def header(self, string: str): - """ - Writes a header message - :param string: - :return: + r"""Writes a header message + + Parameter + --------- + string: :class:`str` + String to write as header """ pass @abstractmethod def trace(self, name: str, message: str): - """ - Writes a trace message - :param name: - :param message: - :return: + r"""Writes a trace message + + Parameter + --------- + name: :class:`str` + Message name + message: :class:`str` + Message string """ pass @abstractmethod def debug(self, name: str, message: str): - """ - Writes a debug message - :param name: - :param message: - :return: + r"""Writes a debug message + + Parameter + --------- + name: :class:`str` + Message name + message: :class:`str` + Message string """ pass @abstractmethod def info(self, name: str, message: str): - """ - Writes an information - :param name: - :param message: - :return: + r"""Writes an information + + Parameter + --------- + name: :class:`str` + Message name + message: :class:`str` + Message string """ pass @abstractmethod def warn(self, name: str, message: str): - """ - Writes an warning - :param name: - :param message: - :return: + r"""Writes an warning + + Parameter + --------- + name: :class:`str` + Message name + message: :class:`str` + Message string """ pass @abstractmethod def error(self, name: str, message: str, ex: Exception = None): - """ - Writes an error - :param name: - :param message: - :param ex: - :return: + r"""Writes an error + + Parameter + --------- + name: :class:`str` + Error name + message: :class:`str` + Error message + ex: :class:`Exception` + Thrown exception """ pass @abstractmethod def fatal(self, name: str, message: str, ex: Exception = None): - """ - Writes an error and exits - :param name: - :param message: - :param ex: - :return: + r"""Writes an error and ends the program + + Parameter + --------- + name: :class:`str` + Error name + message: :class:`str` + Error message + ex: :class:`Exception` + Thrown exception """ pass diff --git a/src/cpl/logging/logger_service.py b/src/cpl/logging/logger_service.py index 4c04a5d2..b27e1320 100644 --- a/src/cpl/logging/logger_service.py +++ b/src/cpl/logging/logger_service.py @@ -13,14 +13,19 @@ from cpl.time.time_format_settings import TimeFormatSettings class Logger(LoggerABC): + r"""Service for logging + + Parameter + --------- + logging_settings: :class:`cpl.logging.logging_settings.LoggingSettings` + Settings for the logger + time_format: :class:`cpl.time.time_format_settings.TimeFormatSettings` + Time format settings + env: :class:`cpl.environment.application_environment_abc.ApplicationEnvironmentABC` + Environment of the application + """ def __init__(self, logging_settings: LoggingSettings, time_format: TimeFormatSettings, env: ApplicationEnvironmentABC): - """ - Service for logging - :param logging_settings: - :param time_format: - :param app_runtime: - """ LoggerABC.__init__(self) self._env = env @@ -38,9 +43,11 @@ class Logger(LoggerABC): self.create() def _get_datetime_now(self) -> str: - """ - Returns the date and time by given format - :return: + r"""Returns the date and time by given format + + Returns + ------- + Date and time in given format """ try: return datetime.datetime.now().strftime(self._time_format_settings.date_time_format) @@ -48,9 +55,11 @@ class Logger(LoggerABC): self.error(__name__, 'Cannot get time', ex=e) def _get_date(self) -> str: - """ - Returns the date by given format - :return: + r"""Returns the date by given format + + Returns + ------- + Date in given format """ try: return datetime.datetime.now().strftime(self._time_format_settings.date_format) @@ -58,10 +67,7 @@ class Logger(LoggerABC): self.error(__name__, 'Cannot get date', ex=e) def create(self) -> None: - """ - Creates path tree and logfile - :return: - """ + r"""Creates path tree and logfile""" """ path """ try: @@ -81,11 +87,12 @@ class Logger(LoggerABC): except Exception as e: self._fatal_console(__name__, 'Cannot open log file', ex=e) - def _append_log(self, string): - """ - Writes to logfile - :param string: - :return: + def _append_log(self, string: str): + r"""Writes to logfile + + Parameter + --------- + string: :class:`str` """ try: # open log file and append always @@ -99,12 +106,20 @@ class Logger(LoggerABC): self._fatal_console(__name__, f'Cannot append log file, message: {string}', ex=e) def _get_string(self, name: str, level: LoggingLevelEnum, message: str) -> str: - """ - Returns input as log entry format - :param name: - :param level: - :param message: - :return: + r"""Returns input as log entry format + + Parameter + --------- + name: :class:`str` + Name of the message + level: :class:`cpl.logging.logging_level_enum.LoggingLevelEnum` + Logging level + message: :class:`str` + Log message + + Returns + ------- + Formatted string for logging """ log_level = level.name return f'<{self._get_datetime_now()}> [ {log_level} ] [ {name} ]: {message}' @@ -209,12 +224,16 @@ class Logger(LoggerABC): exit() def _fatal_console(self, name: str, message: str, ex: Exception = None): - """ - Writes an error to console only - :param name: - :param message: - :param ex: - :return: + r"""Writes an error to console only + + Parameter + --------- + name: :class:`str` + Error name + message: :class:`str` + Error message + ex: :class:`Exception` + Thrown exception """ output = '' if ex is not None: diff --git a/src/cpl/logging/logging_settings.py b/src/cpl/logging/logging_settings.py index 20f87650..6b7128e1 100644 --- a/src/cpl/logging/logging_settings.py +++ b/src/cpl/logging/logging_settings.py @@ -9,6 +9,7 @@ from cpl.logging.logging_settings_name_enum import LoggingSettingsNameEnum class LoggingSettings(ConfigurationModelABC): + r"""Representation of logging settings""" def __init__(self): ConfigurationModelABC.__init__(self) diff --git a/src/cpl/mailing/__init__.py b/src/cpl/mailing/__init__.py index bbce7c2f..2c57dd7e 100644 --- a/src/cpl/mailing/__init__.py +++ b/src/cpl/mailing/__init__.py @@ -15,7 +15,7 @@ __title__ = 'cpl.mailing' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple @@ -27,4 +27,4 @@ from .email_client_settings import EMailClientSettings from .email_client_settings_name_enum import EMailClientSettingsNameEnum VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl/mailing/email.py b/src/cpl/mailing/email.py index d204c070..d4d149e7 100644 --- a/src/cpl/mailing/email.py +++ b/src/cpl/mailing/email.py @@ -2,16 +2,24 @@ import re class EMail: + r"""Represents an email - def __init__(self, header: list[str] = None, subject: str = None, body: str = None, transceiver: str = None, receiver: list[str] = None): - """ - Represents an email - :param header: - :param subject: - :param body: - :param transceiver: - :param receiver: - """ + Parameter + --------- + header: list[:class:`str`] + Header of the E-Mail + subject: :class:`str` + Subject of the E-Mail + body: :class:`str` + Body of the E-Mail + transceiver: :class:`str` + Transceiver of the E-Mail + receiver: list[:class:`str`] + Receiver of the E-Mail + """ + + def __init__(self, header: list[str] = None, subject: str = None, body: str = None, transceiver: str = None, + receiver: list[str] = None): self._header: list[str] = header self._subject: str = subject @@ -73,18 +81,26 @@ class EMail: @staticmethod def check_mail(address: str) -> bool: - """ - Checks if an email is valid - :param address: - :return: + r"""Checks if an email is valid + + Parameter + --------- + address: :class:`str` + The address to check + + Returns + ------- + Result if E-Mail is valid or not """ return bool(re.search('^\\w+([.-]?\\w+)*@\\w+([.-]?\\w+)*(.\\w{2,3})+$', address)) def add_header(self, header: str): - """ - Adds header - :param header: - :return: + r"""Adds header + + Parameter + --------- + header: :class:`str` + The header of the E-Mail """ if self._header is None: self._header = [] @@ -92,10 +108,12 @@ class EMail: self._header.append(header) def add_receiver(self, receiver: str): - """ - Adds receiver - :param receiver: - :return: + r"""Adds receiver + + Parameter + --------- + receiver: :class:`str` + The receiver of the E-Mail """ if self._receiver is None: self._receiver = [] @@ -106,9 +124,17 @@ class EMail: raise Exception(f'Invalid email: {receiver}') def get_content(self, transceiver: str): + r"""Returns the mail as string + + Parameter + --------- + transceiver: :class:`str` + The transceiver of the E-Mail + + Returns + ------- + E-Mail as string """ - Returns the mail as string - :param transceiver: - :return: - """ - return str(f'From: {transceiver}\r\nTo: {self.receiver}\r\n{self.header}\r\nSubject: {self.subject}\r\n{self.body}').encode('utf-8') + return str( + f'From: {transceiver}\r\nTo: {self.receiver}\r\n{self.header}\r\nSubject: {self.subject}\r\n{self.body}').encode( + 'utf-8') diff --git a/src/cpl/mailing/email_client_abc.py b/src/cpl/mailing/email_client_abc.py index 29690394..dfc80424 100644 --- a/src/cpl/mailing/email_client_abc.py +++ b/src/cpl/mailing/email_client_abc.py @@ -4,27 +4,24 @@ from cpl.mailing.email import EMail class EMailClientABC(ABC): + """ABC of :class:`cpl.mailing.email_client_service.EMailClient`""" @abstractmethod def __init__(self): - """ - ABC to send emails - """ ABC.__init__(self) @abstractmethod def connect(self): - """ - Connects to server - :return: - """ + r"""Connects to server""" pass @abstractmethod def send_mail(self, email: EMail): - """ - Sends email - :param email: - :return: + r"""Sends email + + Parameter + --------- + email: :class:`cpl.mailing.email.EMail` + Object of the E-Mail to send """ pass diff --git a/src/cpl/mailing/email_client_service.py b/src/cpl/mailing/email_client_service.py index 170489ff..f169fa11 100644 --- a/src/cpl/mailing/email_client_service.py +++ b/src/cpl/mailing/email_client_service.py @@ -11,14 +11,19 @@ from cpl.utils.credential_manager import CredentialManager class EMailClient(EMailClientABC): + r"""Service to send emails + + Parameter + --------- + environment: :class:`cpl.environment.application_environment_abc.ApplicationEnvironmentABC` + Environment of the application + logger: :class:`cpl.logging.logger_abc.LoggerABC` + The logger to use + mail_settings: :class:`cpl.mailing.email_client_settings.EMailClientSettings` + Settings for mailing + """ def __init__(self, environment: ApplicationEnvironmentABC, logger: LoggerABC, mail_settings: EMailClientSettings): - """ - Service to send emails - :param environment: - :param logger: - :param mail_settings: - """ EMailClientABC.__init__(self) self._environment = environment @@ -30,10 +35,7 @@ class EMailClient(EMailClientABC): self.create() def create(self): - """ - Creates connection - :return: - """ + r"""Creates connection""" self._logger.trace(__name__, f'Started {__name__}.create') self.connect() self._logger.trace(__name__, f'Stopped {__name__}.create') @@ -54,10 +56,7 @@ class EMailClient(EMailClientABC): self._logger.trace(__name__, f'Stopped {__name__}.connect') def login(self): - """ - Login to server - :return: - """ + r"""Login to server""" self._logger.trace(__name__, f'Started {__name__}.login') try: self._logger.debug(__name__, f'Try to login {self._mail_settings.user_name}@{self._mail_settings.host}:{self._mail_settings.port}') diff --git a/src/cpl/mailing/email_client_settings.py b/src/cpl/mailing/email_client_settings.py index 3c75f1e8..31b7f151 100644 --- a/src/cpl/mailing/email_client_settings.py +++ b/src/cpl/mailing/email_client_settings.py @@ -6,6 +6,7 @@ from cpl.mailing.email_client_settings_name_enum import EMailClientSettingsNameE class EMailClientSettings(ConfigurationModelABC): + r"""Representation of mailing settings""" def __init__(self): ConfigurationModelABC.__init__(self) diff --git a/src/cpl/time/__init__.py b/src/cpl/time/__init__.py index e6e22b6a..5d8f524f 100644 --- a/src/cpl/time/__init__.py +++ b/src/cpl/time/__init__.py @@ -15,7 +15,7 @@ __title__ = 'cpl.time' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple @@ -24,4 +24,4 @@ from .time_format_settings import TimeFormatSettings from .time_format_settings_names_enum import TimeFormatSettingsNamesEnum VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl/time/time_format_settings.py b/src/cpl/time/time_format_settings.py index f3f2d9d2..f5d0827e 100644 --- a/src/cpl/time/time_format_settings.py +++ b/src/cpl/time/time_format_settings.py @@ -8,6 +8,7 @@ from cpl.time.time_format_settings_names_enum import TimeFormatSettingsNamesEnum class TimeFormatSettings(ConfigurationModelABC): + r"""Representation of time format settings""" def __init__(self): ConfigurationModelABC.__init__(self) diff --git a/src/cpl/utils/__init__.py b/src/cpl/utils/__init__.py index e3b9690b..5dfe1110 100644 --- a/src/cpl/utils/__init__.py +++ b/src/cpl/utils/__init__.py @@ -15,7 +15,7 @@ __title__ = 'cpl.utils' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple @@ -25,4 +25,4 @@ from .string import String from .pip import Pip VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl/utils/credential_manager.py b/src/cpl/utils/credential_manager.py index 8a40e8dc..f5265403 100644 --- a/src/cpl/utils/credential_manager.py +++ b/src/cpl/utils/credential_manager.py @@ -2,35 +2,52 @@ import base64 class CredentialManager: - """ - Handles credentials - """ + r"""Handles credential encryption and decryption""" @staticmethod def encrypt(string: str) -> str: - """ - Encode with base64 - :param string: - :return: + r"""Encode with base64 + + Parameter + --------- + string: :class:`str` + String to encode + + Returns + ------- + Encoded string """ return base64.b64encode(string.encode('utf-8')).decode('utf-8') @staticmethod def decrypt(string: str) -> str: - """ - Decode with base64 - :param string: - :return: + r"""Decode with base64 + + Parameter + --------- + string: :class:`str` + String to decode + + Returns + ------- + Decoded string """ return base64.b64decode(string).decode('utf-8') @staticmethod def build_string(string: str, credentials: str): - """ - Builds string with credentials in it - :param string: - :param credentials: - :return: + r"""Builds string with credentials in it + + Parameter + --------- + string: :class:`str` + String in which the variable is replaced by credentials + credentials: :class:`str` + String to encode + + Returns + ------- + Decoded string """ return string.replace('$credentials', CredentialManager.decrypt(credentials)) diff --git a/src/cpl/utils/pip.py b/src/cpl/utils/pip.py index b0035a0c..bea3da12 100644 --- a/src/cpl/utils/pip.py +++ b/src/cpl/utils/pip.py @@ -1,3 +1,4 @@ +import os import subprocess import sys from contextlib import suppress @@ -5,55 +6,67 @@ from typing import Optional class Pip: - """ - Executes pip commands - """ + r"""Executes pip commands""" _executable = sys.executable + _env = os.environ + _is_venv = False - """ - Getter - """ - + """Getter""" @classmethod def get_executable(cls) -> str: return cls._executable - """ - Setter - """ - + """Setter""" @classmethod def set_executable(cls, executable: str): + r"""Sets the executable + + Parameter + --------- + executable: :class:`str` + The python command """ - Sets the executable - :param executable: - :return: - """ - if executable is not None: + if executable is not None and executable != sys.executable: cls._executable = executable + if os.path.islink(cls._executable): + cls._is_venv = True + path = os.path.dirname(os.path.dirname(cls._executable)) + cls._env = os.environ + if sys.platform == 'win32': + cls._env['PATH'] = f'{path}\\bin' + os.pathsep + os.environ.get('PATH', '') + else: + cls._env['PATH'] = f'{path}/bin' + os.pathsep + os.environ.get('PATH', '') + cls._env['VIRTUAL_ENV'] = path @classmethod def reset_executable(cls): - """ - Resets the executable to system standard - :return: - """ + r"""Resets the executable to system standard""" cls._executable = sys.executable + cls._is_venv = False - """ - Public utils functions - """ - + """Public utils functions""" @classmethod def get_package(cls, package: str) -> Optional[str]: - """ - Gets given package py local pip list - :param package: - :return: + r"""Gets given package py local pip list + + Parameter + --------- + package: :class:`str` + + Returns + ------- + The package name as string """ result = None with suppress(Exception): - result = subprocess.check_output([cls._executable, "-m", "pip", "show", package], stderr=subprocess.DEVNULL) + args = [cls._executable, "-m", "pip", "show", package] + if cls._is_venv: + args = ["pip", "show", package] + + result = subprocess.check_output( + args, + stderr=subprocess.DEVNULL, env=cls._env + ) if result is None: return None @@ -72,24 +85,38 @@ class Pip: @classmethod def get_outdated(cls) -> bytes: + r"""Gets table of outdated packages + + Returns + ------- + Bytes string of the command result """ - Gets table of outdated packages - :return: - """ - return subprocess.check_output([cls._executable, "-m", "pip", "list", "--outdated"]) + args = [cls._executable, "-m", "pip", "list", "--outdated"] + if cls._is_venv: + args = ["pip", "list", "--outdated"] + + return subprocess.check_output(args, env=cls._env) @classmethod def install(cls, package: str, *args, source: str = None, stdout=None, stderr=None): - """ - Installs given package - :param package: - :param args: - :param source: - :param stdout: - :param stderr: - :return: + r"""Installs given package + + Parameter + --------- + package: :class:`str` + The name of the package + args: :class:`list` + Arguments for the command + source: :class:`str` + Extra index URL + stdout: :class:`str` + Stdout of subprocess.run + stderr: :class:`str` + Stderr of subprocess.run """ pip_args = [cls._executable, "-m", "pip", "install"] + if cls._is_venv: + pip_args = ["pip", "install"] for arg in args: pip_args.append(arg) @@ -99,15 +126,26 @@ class Pip: pip_args.append(source) pip_args.append(package) - subprocess.run(pip_args, stdout=stdout, stderr=stderr) + subprocess.run(pip_args, stdout=stdout, stderr=stderr, env=cls._env) @classmethod def uninstall(cls, package: str, stdout=None, stderr=None): + r"""Uninstalls given package + + Parameter + --------- + package: :class:`str` + The name of the package + stdout: :class:`str` + Stdout of subprocess.run + stderr: :class:`str` + Stderr of subprocess.run """ - Uninstalls given package - :param package: - :param stdout: - :param stderr: - :return: - """ - subprocess.run([cls._executable, "-m", "pip", "uninstall", "--yes", package], stdout=stdout, stderr=stderr) + args = [cls._executable, "-m", "pip", "uninstall", "--yes", package] + if cls._is_venv: + args = ["pip", "uninstall", "--yes", package] + + subprocess.run( + args, + stdout=stdout, stderr=stderr, env=cls._env + ) diff --git a/src/cpl/utils/string.py b/src/cpl/utils/string.py index 29d2da95..5866c8b6 100644 --- a/src/cpl/utils/string.py +++ b/src/cpl/utils/string.py @@ -1,37 +1,91 @@ import re +import string +import random class String: - """ - Useful functions for strings - """ + r"""Useful functions for strings""" @staticmethod - def convert_to_snake_case(name: str) -> str: + def convert_to_camel_case(chars: str) -> str: + r"""Converts string to camel case + + Parameter + --------- + chars: :class:`str` + String to convert + + Returns + ------- + String converted to CamelCase """ - Converts string to snake case - :param name: - :return: + converted_name = chars + char_set = string.punctuation + ' ' + for char in char_set: + if char in converted_name: + converted_name = ''.join(word.title() for word in converted_name.split(char)) + + return converted_name + + @staticmethod + def convert_to_snake_case(chars: str) -> str: + r"""Converts string to snake case + + Parameter + --------- + chars: :class:`str` + String to convert + + Returns + ------- + String converted to snake_case """ + # convert to train-case to CamelCase + if '-' in chars: + chars = ''.join(word.title() for word in chars.split('-')) + pattern1 = re.compile(r'(.)([A-Z][a-z]+)') pattern2 = re.compile(r'([a-z0-9])([A-Z])') - file_name = re.sub(pattern1, r'\1_\2', name) + file_name = re.sub(pattern1, r'\1_\2', chars) return re.sub(pattern2, r'\1_\2', file_name).lower() @staticmethod - def first_to_upper(string: str) -> str: + def first_to_upper(chars: str) -> str: + r"""Converts first char to upper + + Parameter + --------- + chars: :class:`str` + String to convert + + Returns + ------- + String with first char as upper """ - Converts first char to upper - :param string: - :return: - """ - return f'{string[0].upper()}{string[1:]}' + return f'{chars[0].upper()}{chars[1:]}' @staticmethod - def first_to_lower(string: str) -> str: + def first_to_lower(chars: str) -> str: + r"""Converts first char to lower + + Parameter + --------- + chars: :class:`str` + String to convert + + Returns + ------- + String with first char as lower """ - Converts first char to lower - :param string: - :return: + return f'{chars[0].lower()}{chars[1:]}' + + @staticmethod + def random_string(chars: str, length: int) -> str: + r"""Creates random string by given chars and length + + Returns + ------- + String of random chars """ - return f'{string[0].lower()}{string[1:]}' + + return ''.join(random.choice(chars) for _ in range(length)) diff --git a/src/cpl_cli/__init__.py b/src/cpl_cli/__init__.py index c5052acc..ac50d92a 100644 --- a/src/cpl_cli/__init__.py +++ b/src/cpl_cli/__init__.py @@ -1,21 +1,21 @@ # -*- coding: utf-8 -*- """ -sh_cpl sh-edraft Common Python library +sh_cpl-cli sh-edraft Common Python library CLI ~~~~~~~~~~~~~~~~~~~ -sh-edraft Common Python library +sh-edraft Common Python library Command Line Interface :copyright: (c) 2020 - 2021 sh-edraft.de :license: MIT, see LICENSE for more details. """ -__title__ = 'sh_cpl.cpl_cli' +__title__ = 'cpl_cli' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple @@ -29,4 +29,4 @@ from .main import main from .startup import Startup VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl_cli/templates/__init__.py b/src/cpl_cli/_templates/__init__.py similarity index 60% rename from src/cpl_cli/templates/__init__.py rename to src/cpl_cli/_templates/__init__.py index 978cc953..63a2fdf8 100644 --- a/src/cpl_cli/templates/__init__.py +++ b/src/cpl_cli/_templates/__init__.py @@ -1,25 +1,25 @@ # -*- coding: utf-8 -*- """ -sh_cpl sh-edraft Common Python library +sh_cpl-cli sh-edraft Common Python library CLI ~~~~~~~~~~~~~~~~~~~ -sh-edraft Common Python library +sh-edraft Common Python library Command Line Interface :copyright: (c) 2020 - 2021 sh-edraft.de :license: MIT, see LICENSE for more details. """ -__title__ = 'cpl_cli.templates' +__title__ = 'cpl_cli._templates' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple # imports: VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl_cli/templates/generate/__init__.py b/src/cpl_cli/_templates/build/__init__.py similarity index 59% rename from src/cpl_cli/templates/generate/__init__.py rename to src/cpl_cli/_templates/build/__init__.py index 0d30d1c0..e23de64a 100644 --- a/src/cpl_cli/templates/generate/__init__.py +++ b/src/cpl_cli/_templates/build/__init__.py @@ -1,25 +1,25 @@ # -*- coding: utf-8 -*- """ -sh_cpl sh-edraft Common Python library +sh_cpl-cli sh-edraft Common Python library CLI ~~~~~~~~~~~~~~~~~~~ -sh-edraft Common Python library +sh-edraft Common Python library Command Line Interface :copyright: (c) 2020 - 2021 sh-edraft.de :license: MIT, see LICENSE for more details. """ -__title__ = 'cpl_cli.templates.generate' +__title__ = 'cpl_cli._templates.build' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple # imports: VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl_cli/templates/build/init_template.py b/src/cpl_cli/_templates/build/init_template.py similarity index 100% rename from src/cpl_cli/templates/build/init_template.py rename to src/cpl_cli/_templates/build/init_template.py diff --git a/src/cpl_cli/_templates/generate/__init__.py b/src/cpl_cli/_templates/generate/__init__.py new file mode 100644 index 00000000..cdc5b226 --- /dev/null +++ b/src/cpl_cli/_templates/generate/__init__.py @@ -0,0 +1,25 @@ +# -*- coding: utf-8 -*- + +""" +sh_cpl-cli sh-edraft Common Python library CLI +~~~~~~~~~~~~~~~~~~~ + +sh-edraft Common Python library Command Line Interface + +:copyright: (c) 2020 - 2021 sh-edraft.de +:license: MIT, see LICENSE for more details. + +""" + +__title__ = 'cpl_cli._templates.generate' +__author__ = 'Sven Heidemann' +__license__ = 'MIT' +__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' +__version__ = '2021.4.0.post1' + +from collections import namedtuple + +# imports: + +VersionInfo = namedtuple('VersionInfo', 'major minor micro') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl_cli/templates/generate/abc_template.py b/src/cpl_cli/_templates/generate/abc_template.py similarity index 93% rename from src/cpl_cli/templates/generate/abc_template.py rename to src/cpl_cli/_templates/generate/abc_template.py index cb6474a7..b624c3b4 100644 --- a/src/cpl_cli/templates/generate/abc_template.py +++ b/src/cpl_cli/_templates/generate/abc_template.py @@ -2,7 +2,7 @@ import textwrap from string import Template from cpl.utils.string import String -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class ABCTemplate(TemplateFileABC): diff --git a/src/cpl_cli/templates/generate/class_template.py b/src/cpl_cli/_templates/generate/class_template.py similarity index 92% rename from src/cpl_cli/templates/generate/class_template.py rename to src/cpl_cli/_templates/generate/class_template.py index 2c754027..f923ce19 100644 --- a/src/cpl_cli/templates/generate/class_template.py +++ b/src/cpl_cli/_templates/generate/class_template.py @@ -2,7 +2,7 @@ import textwrap from string import Template from cpl.utils.string import String -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class ClassTemplate(TemplateFileABC): diff --git a/src/cpl_cli/templates/generate/configmodel_template.py b/src/cpl_cli/_templates/generate/configmodel_template.py similarity index 96% rename from src/cpl_cli/templates/generate/configmodel_template.py rename to src/cpl_cli/_templates/generate/configmodel_template.py index 2c9461e1..482cec8f 100644 --- a/src/cpl_cli/templates/generate/configmodel_template.py +++ b/src/cpl_cli/_templates/generate/configmodel_template.py @@ -2,7 +2,7 @@ import textwrap from string import Template from cpl.utils.string import String -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class ConfigModelTemplate(TemplateFileABC): diff --git a/src/cpl_cli/templates/generate/enum_template.py b/src/cpl_cli/_templates/generate/enum_template.py similarity index 92% rename from src/cpl_cli/templates/generate/enum_template.py rename to src/cpl_cli/_templates/generate/enum_template.py index 9cf20ab9..2acbf588 100644 --- a/src/cpl_cli/templates/generate/enum_template.py +++ b/src/cpl_cli/_templates/generate/enum_template.py @@ -2,7 +2,7 @@ import textwrap from string import Template from cpl.utils.string import String -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class EnumTemplate(TemplateFileABC): diff --git a/src/cpl_cli/templates/generate/init_template.py b/src/cpl_cli/_templates/generate/init_template.py similarity index 91% rename from src/cpl_cli/templates/generate/init_template.py rename to src/cpl_cli/_templates/generate/init_template.py index 59c0f0fa..39cf238a 100644 --- a/src/cpl_cli/templates/generate/init_template.py +++ b/src/cpl_cli/_templates/generate/init_template.py @@ -2,7 +2,7 @@ import textwrap from string import Template from cpl.utils.string import String -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class InitTemplate(TemplateFileABC): diff --git a/src/cpl_cli/templates/generate/service_template.py b/src/cpl_cli/_templates/generate/service_template.py similarity index 92% rename from src/cpl_cli/templates/generate/service_template.py rename to src/cpl_cli/_templates/generate/service_template.py index 98e5466d..02fefa87 100644 --- a/src/cpl_cli/templates/generate/service_template.py +++ b/src/cpl_cli/_templates/generate/service_template.py @@ -2,7 +2,7 @@ import textwrap from string import Template from cpl.utils.string import String -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class ServiceTemplate(TemplateFileABC): diff --git a/src/cpl_cli/templates/generate/thread_template.py b/src/cpl_cli/_templates/generate/thread_template.py similarity index 93% rename from src/cpl_cli/templates/generate/thread_template.py rename to src/cpl_cli/_templates/generate/thread_template.py index 78c68372..f6876e20 100644 --- a/src/cpl_cli/templates/generate/thread_template.py +++ b/src/cpl_cli/_templates/generate/thread_template.py @@ -2,7 +2,7 @@ import textwrap from string import Template from cpl.utils.string import String -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class ThreadTemplate(TemplateFileABC): diff --git a/src/cpl_cli/templates/build/__init__.py b/src/cpl_cli/_templates/new/__init__.py similarity index 60% rename from src/cpl_cli/templates/build/__init__.py rename to src/cpl_cli/_templates/new/__init__.py index 46603a05..aa202f1e 100644 --- a/src/cpl_cli/templates/build/__init__.py +++ b/src/cpl_cli/_templates/new/__init__.py @@ -1,25 +1,25 @@ # -*- coding: utf-8 -*- """ -sh_cpl sh-edraft Common Python library +sh_cpl-cli sh-edraft Common Python library CLI ~~~~~~~~~~~~~~~~~~~ -sh-edraft Common Python library +sh-edraft Common Python library Command Line Interface :copyright: (c) 2020 - 2021 sh-edraft.de :license: MIT, see LICENSE for more details. """ -__title__ = 'cpl_cli.templates.build' +__title__ = 'cpl_cli._templates.new' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple # imports: VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl_cli/_templates/new/console/__init__.py b/src/cpl_cli/_templates/new/console/__init__.py new file mode 100644 index 00000000..1d9ffcc6 --- /dev/null +++ b/src/cpl_cli/_templates/new/console/__init__.py @@ -0,0 +1,25 @@ +# -*- coding: utf-8 -*- + +""" +sh_cpl-cli sh-edraft Common Python library CLI +~~~~~~~~~~~~~~~~~~~ + +sh-edraft Common Python library Command Line Interface + +:copyright: (c) 2020 - 2021 sh-edraft.de +:license: MIT, see LICENSE for more details. + +""" + +__title__ = 'cpl_cli._templates.new.console' +__author__ = 'Sven Heidemann' +__license__ = 'MIT' +__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' +__version__ = '2021.4.0.post1' + +from collections import namedtuple + +# imports: + +VersionInfo = namedtuple('VersionInfo', 'major minor micro') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl_cli/templates/new/console/appsettings_json.py b/src/cpl_cli/_templates/new/console/appsettings_json.py similarity index 93% rename from src/cpl_cli/templates/new/console/appsettings_json.py rename to src/cpl_cli/_templates/new/console/appsettings_json.py index 04c1a239..5bd03eaa 100644 --- a/src/cpl_cli/templates/new/console/appsettings_json.py +++ b/src/cpl_cli/_templates/new/console/appsettings_json.py @@ -1,6 +1,6 @@ import textwrap -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class AppsettingsTemplate(TemplateFileABC): diff --git a/src/cpl_cli/templates/new/library/license.py b/src/cpl_cli/_templates/new/console/license.py similarity index 86% rename from src/cpl_cli/templates/new/library/license.py rename to src/cpl_cli/_templates/new/console/license.py index d9bcdda7..fb586904 100644 --- a/src/cpl_cli/templates/new/library/license.py +++ b/src/cpl_cli/_templates/new/console/license.py @@ -1,4 +1,4 @@ -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class LicenseTemplate(TemplateFileABC): diff --git a/src/cpl_cli/templates/new/library/readme_py.py b/src/cpl_cli/_templates/new/console/readme_py.py similarity index 85% rename from src/cpl_cli/templates/new/library/readme_py.py rename to src/cpl_cli/_templates/new/console/readme_py.py index 7af465a4..a40286a8 100644 --- a/src/cpl_cli/templates/new/library/readme_py.py +++ b/src/cpl_cli/_templates/new/console/readme_py.py @@ -1,4 +1,4 @@ -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class ReadmeTemplate(TemplateFileABC): diff --git a/src/cpl_cli/_templates/new/console/source/__init__.py b/src/cpl_cli/_templates/new/console/source/__init__.py new file mode 100644 index 00000000..60b39e73 --- /dev/null +++ b/src/cpl_cli/_templates/new/console/source/__init__.py @@ -0,0 +1,25 @@ +# -*- coding: utf-8 -*- + +""" +sh_cpl-cli sh-edraft Common Python library CLI +~~~~~~~~~~~~~~~~~~~ + +sh-edraft Common Python library Command Line Interface + +:copyright: (c) 2020 - 2021 sh-edraft.de +:license: MIT, see LICENSE for more details. + +""" + +__title__ = 'cpl_cli._templates.new.console.source' +__author__ = 'Sven Heidemann' +__license__ = 'MIT' +__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' +__version__ = '2021.4.0.post1' + +from collections import namedtuple + +# imports: + +VersionInfo = namedtuple('VersionInfo', 'major minor micro') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl_cli/_templates/new/console/source/name/__init__.py b/src/cpl_cli/_templates/new/console/source/name/__init__.py new file mode 100644 index 00000000..5412d15c --- /dev/null +++ b/src/cpl_cli/_templates/new/console/source/name/__init__.py @@ -0,0 +1,25 @@ +# -*- coding: utf-8 -*- + +""" +sh_cpl-cli sh-edraft Common Python library CLI +~~~~~~~~~~~~~~~~~~~ + +sh-edraft Common Python library Command Line Interface + +:copyright: (c) 2020 - 2021 sh-edraft.de +:license: MIT, see LICENSE for more details. + +""" + +__title__ = 'cpl_cli._templates.new.console.source.name' +__author__ = 'Sven Heidemann' +__license__ = 'MIT' +__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' +__version__ = '2021.4.0.post1' + +from collections import namedtuple + +# imports: + +VersionInfo = namedtuple('VersionInfo', 'major minor micro') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl_cli/templates/new/console/src/name/application.py b/src/cpl_cli/_templates/new/console/source/name/application.py similarity index 82% rename from src/cpl_cli/templates/new/console/src/name/application.py rename to src/cpl_cli/_templates/new/console/source/name/application.py index 516c77aa..934f0522 100644 --- a/src/cpl_cli/templates/new/console/src/name/application.py +++ b/src/cpl_cli/_templates/new/console/source/name/application.py @@ -1,17 +1,15 @@ import textwrap -from cpl.utils.string import String -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class ApplicationTemplate(TemplateFileABC): - def __init__(self, name: str): + def __init__(self, name: str, path: str): TemplateFileABC.__init__(self) - name = String.convert_to_snake_case(name) self._name = 'application.py' - self._path = f'src/{name}/' + self._path = path self._value = textwrap.dedent("""\ from cpl.application import ApplicationABC from cpl.configuration import ConfigurationABC diff --git a/src/cpl_cli/templates/new/library/src/name/init.py b/src/cpl_cli/_templates/new/console/source/name/init.py similarity index 68% rename from src/cpl_cli/templates/new/library/src/name/init.py rename to src/cpl_cli/_templates/new/console/source/name/init.py index ebb078a7..b3cbdecb 100644 --- a/src/cpl_cli/templates/new/library/src/name/init.py +++ b/src/cpl_cli/_templates/new/console/source/name/init.py @@ -1,15 +1,15 @@ import textwrap -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC -class TestsInitTemplate(TemplateFileABC): +class MainInitTemplate(TemplateFileABC): - def __init__(self, name: str): + def __init__(self, name: str, path: str): TemplateFileABC.__init__(self) self._name = '__init__.py' - self._path = f'src/{name}/' + self._path = path self._value = textwrap.dedent("""\ # imports: """) diff --git a/src/cpl_cli/templates/new/console/src/name/main.py b/src/cpl_cli/_templates/new/console/source/name/main.py similarity index 84% rename from src/cpl_cli/templates/new/console/src/name/main.py rename to src/cpl_cli/_templates/new/console/source/name/main.py index 7a3cb7ac..861258a1 100644 --- a/src/cpl_cli/templates/new/console/src/name/main.py +++ b/src/cpl_cli/_templates/new/console/source/name/main.py @@ -1,22 +1,25 @@ import textwrap from cpl.utils.string import String -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class MainWithApplicationHostAndStartupTemplate(TemplateFileABC): - def __init__(self, name: str): + def __init__(self, name: str, path: str): TemplateFileABC.__init__(self) name = String.convert_to_snake_case(name) self._name = 'main.py' - self._path = f'src/{name}/' + self._path = path + + import_pkg = f'{name}.' + self._value = textwrap.dedent(f"""\ from cpl.application import ApplicationBuilder - from {name}.application import Application - from {name}.startup import Startup + from {import_pkg}application import Application + from {import_pkg}startup import Startup def main(): @@ -44,16 +47,19 @@ class MainWithApplicationHostAndStartupTemplate(TemplateFileABC): class MainWithApplicationBaseTemplate(TemplateFileABC): - def __init__(self, name: str): + def __init__(self, name: str, path: str): TemplateFileABC.__init__(self) name = String.convert_to_snake_case(name) self._name = 'main.py' - self._path = f'src/{name}' + self._path = path + + import_pkg = f'{name}.' + self._value = textwrap.dedent(f"""\ from cpl.application import ApplicationBuilder - from {name}.application import Application + from {import_pkg}application import Application def main(): @@ -80,12 +86,15 @@ class MainWithApplicationBaseTemplate(TemplateFileABC): class MainWithoutApplicationBaseTemplate(TemplateFileABC): - def __init__(self, name: str): + def __init__(self, name: str, path: str): TemplateFileABC.__init__(self) name = String.convert_to_snake_case(name) self._name = 'main.py' - self._path = f'src/{name}' + self._path = path + + import_pkg = f'{name}.' + self._value = textwrap.dedent("""\ from cpl.console import Console @@ -113,12 +122,15 @@ class MainWithoutApplicationBaseTemplate(TemplateFileABC): class MainWithDependencyInjection(TemplateFileABC): - def __init__(self, name: str): + def __init__(self, name: str, path: str): TemplateFileABC.__init__(self) name = String.convert_to_snake_case(name) self._name = 'main.py' - self._path = f'src/{name}' + self._path = path + + import_pkg = f'{name}.' + self._value = textwrap.dedent("""\ from cpl.configuration import Configuration, ConfigurationABC from cpl.console import Console diff --git a/src/cpl_cli/templates/new/console/src/name/startup.py b/src/cpl_cli/_templates/new/console/source/name/startup.py similarity index 85% rename from src/cpl_cli/templates/new/console/src/name/startup.py rename to src/cpl_cli/_templates/new/console/source/name/startup.py index 90881b96..6e68b355 100644 --- a/src/cpl_cli/templates/new/console/src/name/startup.py +++ b/src/cpl_cli/_templates/new/console/source/name/startup.py @@ -1,17 +1,15 @@ import textwrap -from cpl.utils.string import String -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class StartupTemplate(TemplateFileABC): - def __init__(self, name: str): + def __init__(self, name: str, path: str): TemplateFileABC.__init__(self) - name = String.convert_to_snake_case(name) self._name = 'startup.py' - self._path = f'src/{name}/' + self._path = path self._value = textwrap.dedent("""\ from cpl.application import StartupABC from cpl.configuration import ConfigurationABC diff --git a/src/cpl_cli/_templates/new/console/source/tests/__init__.py b/src/cpl_cli/_templates/new/console/source/tests/__init__.py new file mode 100644 index 00000000..c7475332 --- /dev/null +++ b/src/cpl_cli/_templates/new/console/source/tests/__init__.py @@ -0,0 +1,25 @@ +# -*- coding: utf-8 -*- + +""" +sh_cpl-cli sh-edraft Common Python library CLI +~~~~~~~~~~~~~~~~~~~ + +sh-edraft Common Python library Command Line Interface + +:copyright: (c) 2020 - 2021 sh-edraft.de +:license: MIT, see LICENSE for more details. + +""" + +__title__ = 'cpl_cli._templates.new.console.source.tests' +__author__ = 'Sven Heidemann' +__license__ = 'MIT' +__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' +__version__ = '2021.4.0.post1' + +from collections import namedtuple + +# imports: + +VersionInfo = namedtuple('VersionInfo', 'major minor micro') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl_cli/templates/new/library/src/tests/init.py b/src/cpl_cli/_templates/new/console/source/tests/init.py similarity index 88% rename from src/cpl_cli/templates/new/library/src/tests/init.py rename to src/cpl_cli/_templates/new/console/source/tests/init.py index 3358c6f6..338ad115 100644 --- a/src/cpl_cli/templates/new/library/src/tests/init.py +++ b/src/cpl_cli/_templates/new/console/source/tests/init.py @@ -1,6 +1,6 @@ import textwrap -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class TestsInitTemplate(TemplateFileABC): diff --git a/src/cpl_cli/_templates/new/library/__init__.py b/src/cpl_cli/_templates/new/library/__init__.py new file mode 100644 index 00000000..77eb1211 --- /dev/null +++ b/src/cpl_cli/_templates/new/library/__init__.py @@ -0,0 +1,25 @@ +# -*- coding: utf-8 -*- + +""" +sh_cpl-cli sh-edraft Common Python library CLI +~~~~~~~~~~~~~~~~~~~ + +sh-edraft Common Python library Command Line Interface + +:copyright: (c) 2020 - 2021 sh-edraft.de +:license: MIT, see LICENSE for more details. + +""" + +__title__ = 'cpl_cli._templates.new.library' +__author__ = 'Sven Heidemann' +__license__ = 'MIT' +__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' +__version__ = '2021.4.0.post1' + +from collections import namedtuple + +# imports: + +VersionInfo = namedtuple('VersionInfo', 'major minor micro') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl_cli/templates/new/library/appsettings_json.py b/src/cpl_cli/_templates/new/library/appsettings_json.py similarity index 93% rename from src/cpl_cli/templates/new/library/appsettings_json.py rename to src/cpl_cli/_templates/new/library/appsettings_json.py index 04c1a239..5bd03eaa 100644 --- a/src/cpl_cli/templates/new/library/appsettings_json.py +++ b/src/cpl_cli/_templates/new/library/appsettings_json.py @@ -1,6 +1,6 @@ import textwrap -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class AppsettingsTemplate(TemplateFileABC): diff --git a/src/cpl_cli/templates/new/console/license.py b/src/cpl_cli/_templates/new/library/license.py similarity index 86% rename from src/cpl_cli/templates/new/console/license.py rename to src/cpl_cli/_templates/new/library/license.py index d9bcdda7..fb586904 100644 --- a/src/cpl_cli/templates/new/console/license.py +++ b/src/cpl_cli/_templates/new/library/license.py @@ -1,4 +1,4 @@ -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class LicenseTemplate(TemplateFileABC): diff --git a/src/cpl_cli/templates/new/console/readme_py.py b/src/cpl_cli/_templates/new/library/readme_py.py similarity index 85% rename from src/cpl_cli/templates/new/console/readme_py.py rename to src/cpl_cli/_templates/new/library/readme_py.py index 7af465a4..a40286a8 100644 --- a/src/cpl_cli/templates/new/console/readme_py.py +++ b/src/cpl_cli/_templates/new/library/readme_py.py @@ -1,4 +1,4 @@ -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class ReadmeTemplate(TemplateFileABC): diff --git a/src/cpl_cli/_templates/new/library/source/__init__.py b/src/cpl_cli/_templates/new/library/source/__init__.py new file mode 100644 index 00000000..6da35363 --- /dev/null +++ b/src/cpl_cli/_templates/new/library/source/__init__.py @@ -0,0 +1,25 @@ +# -*- coding: utf-8 -*- + +""" +sh_cpl-cli sh-edraft Common Python library CLI +~~~~~~~~~~~~~~~~~~~ + +sh-edraft Common Python library Command Line Interface + +:copyright: (c) 2020 - 2021 sh-edraft.de +:license: MIT, see LICENSE for more details. + +""" + +__title__ = 'cpl_cli._templates.new.library.source' +__author__ = 'Sven Heidemann' +__license__ = 'MIT' +__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' +__version__ = '2021.4.0.post1' + +from collections import namedtuple + +# imports: + +VersionInfo = namedtuple('VersionInfo', 'major minor micro') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl_cli/_templates/new/library/source/name/__init__.py b/src/cpl_cli/_templates/new/library/source/name/__init__.py new file mode 100644 index 00000000..06de3ab9 --- /dev/null +++ b/src/cpl_cli/_templates/new/library/source/name/__init__.py @@ -0,0 +1,25 @@ +# -*- coding: utf-8 -*- + +""" +sh_cpl-cli sh-edraft Common Python library CLI +~~~~~~~~~~~~~~~~~~~ + +sh-edraft Common Python library Command Line Interface + +:copyright: (c) 2020 - 2021 sh-edraft.de +:license: MIT, see LICENSE for more details. + +""" + +__title__ = 'cpl_cli._templates.new.library.source.name' +__author__ = 'Sven Heidemann' +__license__ = 'MIT' +__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' +__version__ = '2021.4.0.post1' + +from collections import namedtuple + +# imports: + +VersionInfo = namedtuple('VersionInfo', 'major minor micro') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl_cli/templates/new/library/src/cli/application.py b/src/cpl_cli/_templates/new/library/source/name/application.py similarity index 82% rename from src/cpl_cli/templates/new/library/src/cli/application.py rename to src/cpl_cli/_templates/new/library/source/name/application.py index 0d92c2cc..934f0522 100644 --- a/src/cpl_cli/templates/new/library/src/cli/application.py +++ b/src/cpl_cli/_templates/new/library/source/name/application.py @@ -1,17 +1,15 @@ import textwrap -from cpl.utils.string import String -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class ApplicationTemplate(TemplateFileABC): - def __init__(self, name: str): + def __init__(self, name: str, path: str): TemplateFileABC.__init__(self) - name = String.convert_to_snake_case(name) self._name = 'application.py' - self._path = f'src/{name}_cli/' + self._path = path self._value = textwrap.dedent("""\ from cpl.application import ApplicationABC from cpl.configuration import ConfigurationABC diff --git a/src/cpl_cli/templates/new/console/src/name/init.py b/src/cpl_cli/_templates/new/library/source/name/init.py similarity index 59% rename from src/cpl_cli/templates/new/console/src/name/init.py rename to src/cpl_cli/_templates/new/library/source/name/init.py index 9cdd21ad..a3b0b8ea 100644 --- a/src/cpl_cli/templates/new/console/src/name/init.py +++ b/src/cpl_cli/_templates/new/library/source/name/init.py @@ -1,17 +1,15 @@ import textwrap -from cpl.utils.string import String -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC -class MainInitTemplate(TemplateFileABC): +class NameInitTemplate(TemplateFileABC): - def __init__(self, name: str): + def __init__(self, name: str, path: str): TemplateFileABC.__init__(self) - name = String.convert_to_snake_case(name) self._name = '__init__.py' - self._path = f'src/{name}/' + self._path = path self._value = textwrap.dedent("""\ # imports: """) diff --git a/src/cpl_cli/templates/new/library/src/cli/main.py b/src/cpl_cli/_templates/new/library/source/name/main.py similarity index 82% rename from src/cpl_cli/templates/new/library/src/cli/main.py rename to src/cpl_cli/_templates/new/library/source/name/main.py index 248cdb3e..5d43bf3a 100644 --- a/src/cpl_cli/templates/new/library/src/cli/main.py +++ b/src/cpl_cli/_templates/new/library/source/name/main.py @@ -1,22 +1,25 @@ import textwrap -from cpl.utils.string import String -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class MainWithApplicationHostAndStartupTemplate(TemplateFileABC): - def __init__(self, name: str): + def __init__(self, name: str, path: str): TemplateFileABC.__init__(self) - name = String.convert_to_snake_case(name) self._name = 'main.py' - self._path = f'src/{name}_cli/' + self._path = path + + import_pkg = f'{name}.' + if name == '': + import_pkg = '' + self._value = textwrap.dedent(f"""\ from cpl.application import ApplicationBuilder - from {name}_cli.application import Application - from {name}_cli.startup import Startup + from {import_pkg}application import Application + from {import_pkg}startup import Startup def main(): @@ -44,15 +47,20 @@ class MainWithApplicationHostAndStartupTemplate(TemplateFileABC): class MainWithApplicationBaseTemplate(TemplateFileABC): - def __init__(self): + def __init__(self, name: str, path: str): TemplateFileABC.__init__(self) self._name = 'main.py' - self._path = 'src/' + self._path = path + + import_pkg = f'{name}.' + if name == '': + import_pkg = '' + self._value = textwrap.dedent(f"""\ from cpl.application import ApplicationBuilder - from {name}_cli.application import Application + from {import_pkg}application import Application def main(): @@ -79,11 +87,12 @@ class MainWithApplicationBaseTemplate(TemplateFileABC): class MainWithoutApplicationBaseTemplate(TemplateFileABC): - def __init__(self): + def __init__(self, name: str, path: str): TemplateFileABC.__init__(self) self._name = 'main.py' - self._path = 'src/' + self._path = path + self._value = textwrap.dedent("""\ from cpl.console import Console @@ -111,11 +120,12 @@ class MainWithoutApplicationBaseTemplate(TemplateFileABC): class MainWithDependencyInjection(TemplateFileABC): - def __init__(self): + def __init__(self, name: str, path: str): TemplateFileABC.__init__(self) self._name = 'main.py' - self._path = 'src/' + self._path = path + self._value = textwrap.dedent("""\ from cpl.configuration import Configuration, ConfigurationABC from cpl.console import Console diff --git a/src/cpl_cli/templates/new/library/src/cli/startup.py b/src/cpl_cli/_templates/new/library/source/name/startup.py similarity index 84% rename from src/cpl_cli/templates/new/library/src/cli/startup.py rename to src/cpl_cli/_templates/new/library/source/name/startup.py index 0e33e643..6e68b355 100644 --- a/src/cpl_cli/templates/new/library/src/cli/startup.py +++ b/src/cpl_cli/_templates/new/library/source/name/startup.py @@ -1,17 +1,15 @@ import textwrap -from cpl.utils.string import String -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class StartupTemplate(TemplateFileABC): - def __init__(self, name: str): + def __init__(self, name: str, path: str): TemplateFileABC.__init__(self) - name = String.convert_to_snake_case(name) self._name = 'startup.py' - self._path = f'src/{name}_cli/' + self._path = path self._value = textwrap.dedent("""\ from cpl.application import StartupABC from cpl.configuration import ConfigurationABC diff --git a/src/cpl_cli/_templates/new/library/source/tests/__init__.py b/src/cpl_cli/_templates/new/library/source/tests/__init__.py new file mode 100644 index 00000000..8ebc0434 --- /dev/null +++ b/src/cpl_cli/_templates/new/library/source/tests/__init__.py @@ -0,0 +1,25 @@ +# -*- coding: utf-8 -*- + +""" +sh_cpl-cli sh-edraft Common Python library CLI +~~~~~~~~~~~~~~~~~~~ + +sh-edraft Common Python library Command Line Interface + +:copyright: (c) 2020 - 2021 sh-edraft.de +:license: MIT, see LICENSE for more details. + +""" + +__title__ = 'cpl_cli._templates.new.library.source.tests' +__author__ = 'Sven Heidemann' +__license__ = 'MIT' +__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' +__version__ = '2021.4.0.post1' + +from collections import namedtuple + +# imports: + +VersionInfo = namedtuple('VersionInfo', 'major minor micro') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl_cli/templates/new/console/src/tests/init.py b/src/cpl_cli/_templates/new/library/source/tests/init.py similarity index 88% rename from src/cpl_cli/templates/new/console/src/tests/init.py rename to src/cpl_cli/_templates/new/library/source/tests/init.py index 3358c6f6..338ad115 100644 --- a/src/cpl_cli/templates/new/console/src/tests/init.py +++ b/src/cpl_cli/_templates/new/library/source/tests/init.py @@ -1,6 +1,6 @@ import textwrap -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class TestsInitTemplate(TemplateFileABC): diff --git a/src/cpl_cli/templates/new/__init__.py b/src/cpl_cli/_templates/publish/__init__.py similarity index 59% rename from src/cpl_cli/templates/new/__init__.py rename to src/cpl_cli/_templates/publish/__init__.py index 62c8d6be..7a31ca7b 100644 --- a/src/cpl_cli/templates/new/__init__.py +++ b/src/cpl_cli/_templates/publish/__init__.py @@ -1,25 +1,25 @@ # -*- coding: utf-8 -*- """ -sh_cpl sh-edraft Common Python library +sh_cpl-cli sh-edraft Common Python library CLI ~~~~~~~~~~~~~~~~~~~ -sh-edraft Common Python library +sh-edraft Common Python library Command Line Interface :copyright: (c) 2020 - 2021 sh-edraft.de :license: MIT, see LICENSE for more details. """ -__title__ = 'cpl_cli.templates.new' +__title__ = 'cpl_cli._templates.publish' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple # imports: VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl_cli/templates/publish/setup_template.py b/src/cpl_cli/_templates/publish/setup_template.py similarity index 100% rename from src/cpl_cli/templates/publish/setup_template.py rename to src/cpl_cli/_templates/publish/setup_template.py diff --git a/src/cpl_cli/templates/template_file_abc.py b/src/cpl_cli/_templates/template_file_abc.py similarity index 100% rename from src/cpl_cli/templates/template_file_abc.py rename to src/cpl_cli/_templates/template_file_abc.py diff --git a/src/cpl_cli/cli.py b/src/cpl_cli/cli.py index 8547844e..a4e029f7 100644 --- a/src/cpl_cli/cli.py +++ b/src/cpl_cli/cli.py @@ -4,11 +4,13 @@ from cpl.application.application_abc import ApplicationABC from cpl.configuration.configuration_abc import ConfigurationABC from cpl.console.console import Console from cpl.dependency_injection import ServiceProviderABC +from cpl_cli.command.add_service import AddService from cpl_cli.command.build_service import BuildService from cpl_cli.command.generate_service import GenerateService from cpl_cli.command.install_service import InstallService from cpl_cli.command.new_service import NewService from cpl_cli.command.publish_service import PublishService +from cpl_cli.command.remove_service import RemoveService from cpl_cli.command.start_service import StartService from cpl_cli.command.uninstall_service import UninstallService from cpl_cli.command.update_service import UpdateService @@ -28,20 +30,26 @@ class CLI(ApplicationABC): ApplicationABC.__init__(self, config, services) self._command_handler: Optional[CommandHandler] = None + self._options: list[str] = [] def configure(self): self._command_handler: CommandHandler = self._services.get_service(CommandHandler) - self._command_handler.add_command(CommandModel('build', ['h', 'B'], BuildService, True)) - self._command_handler.add_command(CommandModel('generate', ['g', 'G'], GenerateService, True)) - self._command_handler.add_command(CommandModel('help', ['h', 'H'], HelpService, False)) - self._command_handler.add_command(CommandModel('install', ['i', 'I'], InstallService, True)) - self._command_handler.add_command(CommandModel('new', ['n', 'N'], NewService, False)) - self._command_handler.add_command(CommandModel('publish', ['p', 'P'], PublishService, True)) - self._command_handler.add_command(CommandModel('start', ['s', 'S'], StartService, True)) - self._command_handler.add_command(CommandModel('uninstall', ['ui', 'UI'], UninstallService, True)) - self._command_handler.add_command(CommandModel('update', ['u', 'U'], UpdateService, True)) - self._command_handler.add_command(CommandModel('version', ['v', 'V'], VersionService, False)) + self._command_handler.add_command(CommandModel('add', ['a', 'a'], AddService, False, False, False)) + self._command_handler.add_command(CommandModel('build', ['b', 'B'], BuildService, False, True, True)) + self._command_handler.add_command(CommandModel('generate', ['g', 'G'], GenerateService, False, True, False)) + self._command_handler.add_command(CommandModel('help', ['h', 'H'], HelpService, False, False, False)) + self._command_handler.add_command(CommandModel('install', ['i', 'I'], InstallService, False, True, True)) + self._command_handler.add_command(CommandModel('new', ['n', 'N'], NewService, False, False, True)) + self._command_handler.add_command(CommandModel('publish', ['p', 'P'], PublishService, False, True, True)) + self._command_handler.add_command(CommandModel('remove', ['r', 'R'], RemoveService, True, True, False)) + self._command_handler.add_command(CommandModel('start', ['s', 'S'], StartService, False, True, True)) + self._command_handler.add_command(CommandModel('uninstall', ['ui', 'UI'], UninstallService, False, True, True)) + self._command_handler.add_command(CommandModel('update', ['u', 'U'], UpdateService, False, True, True)) + self._command_handler.add_command(CommandModel('version', ['v', 'V'], VersionService, False, False, False)) + + self._command_handler.add_command(CommandModel('--help', ['-h', '-H'], HelpService, False, False, False)) + self._options.append('--help') def main(self): """ @@ -52,16 +60,46 @@ class CLI(ApplicationABC): command = None args = [] if len(self._configuration.additional_arguments) > 0: - command = self._configuration.additional_arguments[0] - if len(self._configuration.additional_arguments) > 1: - args = self._configuration.additional_arguments[1:] + is_option = False + for opt in self._options: + if opt in self._configuration.additional_arguments: + is_option = True + command = opt + args = self._configuration.additional_arguments + args.remove(opt) + + if not is_option: + command = self._configuration.additional_arguments[0] + if len(self._configuration.additional_arguments) > 1: + args = self._configuration.additional_arguments[1:] else: for cmd in self._command_handler.commands: result = self._configuration.get_configuration(cmd.name) - if result is not None: + result_args: list[str] = self._configuration.get_configuration(f'{cmd.name}AdditionalArguments') + is_option = False + for opt in self._options: + if opt == result: + is_option = True + command = opt + + elif result_args is not None and opt in result_args: + is_option = True + command = opt + result_args.remove(opt) + + if is_option: + args.append(cmd.name) + if result_args is not None: + for arg in result_args: + args.append(arg) + + elif result is not None: command = cmd.name args.append(result) + for arg in result_args: + args.append(arg) + if command is None: Error.error(f'Expected command') return diff --git a/src/cpl_cli/command/__init__.py b/src/cpl_cli/command/__init__.py index b316c90b..4dd948d6 100644 --- a/src/cpl_cli/command/__init__.py +++ b/src/cpl_cli/command/__init__.py @@ -1,10 +1,10 @@ # -*- coding: utf-8 -*- """ -sh_cpl sh-edraft Common Python library +sh_cpl-cli sh-edraft Common Python library CLI ~~~~~~~~~~~~~~~~~~~ -sh-edraft Common Python library +sh-edraft Common Python library Command Line Interface :copyright: (c) 2020 - 2021 sh-edraft.de :license: MIT, see LICENSE for more details. @@ -15,7 +15,7 @@ __title__ = 'cpl_cli.command' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple @@ -28,4 +28,4 @@ from .publish_service import PublishService from .version_service import VersionService VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl_cli/command/add_service.py b/src/cpl_cli/command/add_service.py new file mode 100644 index 00000000..30d2dd17 --- /dev/null +++ b/src/cpl_cli/command/add_service.py @@ -0,0 +1,126 @@ +import json +import os +import textwrap +from typing import Optional + +from cpl.configuration.configuration_abc import ConfigurationABC +from cpl.console.console import Console +from cpl.console.foreground_color_enum import ForegroundColorEnum +from cpl_cli.command_abc import CommandABC +from cpl_cli.configuration.build_settings import BuildSettings +from cpl_cli.configuration.project_settings import ProjectSettings +from cpl_cli.configuration.settings_helper import SettingsHelper +from cpl_cli.configuration.workspace_settings import WorkspaceSettings + + +class AddService(CommandABC): + + def __init__(self, config: ConfigurationABC, workspace: WorkspaceSettings): + """ + Service for CLI command add + """ + CommandABC.__init__(self) + + self._config = config + + self._workspace = workspace + + @property + def help_message(self) -> str: + return textwrap.dedent("""\ + Adds a project reference to given project. + Usage: cpl add + + Arguments: + source-project: Name of the project to which the reference has to be + target-project: Name of the project to be referenced + """) + + @staticmethod + def _edit_project_file(source: str, project_settings: ProjectSettings, build_settings: BuildSettings): + with open(source, 'w') as file: + file.write(json.dumps({ + ProjectSettings.__name__: SettingsHelper.get_project_settings_dict(project_settings), + BuildSettings.__name__: SettingsHelper.get_build_settings_dict(build_settings) + }, indent=2)) + file.close() + + def run(self, args: list[str]): + """ + Entry point of command + :param args: + :return: + """ + if len(args) == 0: + Console.error('Expected source and target project') + return + + elif len(args) == 1: + Console.error('Expected target project') + return + + elif len(args) > 2: + Console.error(f'Unexpected argument: {" ".join(args[2:])}') + return + + # file names + source = args[0] + target = args[1] + # validation flags + is_invalid_source = False + is_invalid_target = source == target + + if not is_invalid_target: + if self._workspace is None: + is_invalid_source = not os.path.isfile(source) + is_invalid_target = not os.path.isfile(target) + + else: + if source not in self._workspace.projects: + is_invalid_source = True + + else: + source = self._workspace.projects[source] + + if target not in self._workspace.projects: + is_invalid_target = True + + else: + target = self._workspace.projects[target] + + # load project-name.json + self._config.add_json_file(source, optional=True, output=False) + project_settings: Optional[ProjectSettings] = self._config.get_configuration(ProjectSettings) + build_settings: Optional[BuildSettings] = self._config.get_configuration(BuildSettings) + + if project_settings is None or build_settings is None: + is_invalid_source = True + + if is_invalid_source: + Console.error(f'Invalid source: {source}') + return + + if is_invalid_target or source == target or not os.path.isfile(target): + Console.error(f'Invalid target: {target}') + return + + if target in build_settings.project_references: + Console.error(f'Project reference already exists.') + return + + if self._workspace is None: + target = f'../{target}' + else: + target = target.replace('src', '..') + + build_settings.project_references.append(target) + + Console.spinner( + f'Editing {source}', + self._edit_project_file, + source, + project_settings, + build_settings, + text_foreground_color=ForegroundColorEnum.green, + spinner_foreground_color=ForegroundColorEnum.cyan + ) diff --git a/src/cpl_cli/command/build_service.py b/src/cpl_cli/command/build_service.py index 18ce4dbd..5fe1bc72 100644 --- a/src/cpl_cli/command/build_service.py +++ b/src/cpl_cli/command/build_service.py @@ -1,3 +1,5 @@ +import textwrap + from cpl_cli.command_abc import CommandABC from cpl_cli.publish.publisher_abc import PublisherABC @@ -13,6 +15,13 @@ class BuildService(CommandABC): self._publisher = publisher + @property + def help_message(self) -> str: + return textwrap.dedent("""\ + Copies an python app into an output directory named build/ at the given output path. Must be executed within a CPL workspace or project directory + Usage: cpl build + """) + def run(self, args: list[str]): """ Entry point of command diff --git a/src/cpl_cli/command/generate_service.py b/src/cpl_cli/command/generate_service.py index 7a084e6e..9ad04172 100644 --- a/src/cpl_cli/command/generate_service.py +++ b/src/cpl_cli/command/generate_service.py @@ -1,4 +1,5 @@ import os +import textwrap from collections import Callable from cpl.configuration.configuration_abc import ConfigurationABC @@ -6,14 +7,14 @@ from cpl.console.foreground_color_enum import ForegroundColorEnum from cpl.console.console import Console from cpl.utils.string import String from cpl_cli.command_abc import CommandABC -from cpl_cli.templates.generate.init_template import InitTemplate -from cpl_cli.templates.generate.abc_template import ABCTemplate -from cpl_cli.templates.generate.class_template import ClassTemplate -from cpl_cli.templates.generate.configmodel_template import ConfigModelTemplate -from cpl_cli.templates.generate.enum_template import EnumTemplate -from cpl_cli.templates.generate.service_template import ServiceTemplate -from cpl_cli.templates.generate.thread_template import ThreadTemplate -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.generate.init_template import InitTemplate +from cpl_cli._templates.generate.abc_template import ABCTemplate +from cpl_cli._templates.generate.class_template import ClassTemplate +from cpl_cli._templates.generate.configmodel_template import ConfigModelTemplate +from cpl_cli._templates.generate.enum_template import EnumTemplate +from cpl_cli._templates.generate.service_template import ServiceTemplate +from cpl_cli._templates.generate.thread_template import ThreadTemplate +from cpl_cli._templates.template_file_abc import TemplateFileABC class GenerateService(CommandABC): @@ -55,6 +56,25 @@ class GenerateService(CommandABC): self._config = configuration self._env = self._config.environment + @property + def help_message(self) -> str: + return textwrap.dedent("""\ + Generate a file based on schematic. + Usage: cpl generate + + Arguments: + schematic: The schematic to generate. + name: The name of the generated file + + Schematics: + abc + class + enum + service + settings + thread + """) + @staticmethod def _help(message: str): """ @@ -102,6 +122,9 @@ class GenerateService(CommandABC): rel_path = '/'.join(parts[:-1]) class_name = parts[len(parts) - 1] + if 'src' not in rel_path: + rel_path = f'src/{rel_path}' + template = template(class_name, schematic, self._schematics[schematic]["Upper"], rel_path) file_path = os.path.join(self._env.working_directory, template.path, template.name) diff --git a/src/cpl_cli/command/help_service.py b/src/cpl_cli/command/help_service.py index 5088b379..50e98921 100644 --- a/src/cpl_cli/command/help_service.py +++ b/src/cpl_cli/command/help_service.py @@ -1,31 +1,66 @@ +import textwrap +from typing import Optional + from cpl.console.console import Console from cpl.console.foreground_color_enum import ForegroundColorEnum +from cpl.dependency_injection.service_provider_abc import ServiceProviderABC +from cpl_cli.command_handler_service import CommandHandler from cpl_cli.command_abc import CommandABC class HelpService(CommandABC): - def __init__(self): + def __init__(self, services: ServiceProviderABC, cmd_handler: CommandHandler): """ Service for CLI command help """ CommandABC.__init__(self) + self._services = services + self._commands = cmd_handler.commands + + @property + def help_message(self) -> str: + return textwrap.dedent("""\ + Lists available command and their short descriptions. + Usage: cpl help + + Arguments: + command The command to display the help message for + """) + def run(self, args: list[str]): """ Entry point of command :param args: :return: """ + if len(args) > 0: + command_name = args[0] + command: Optional[CommandABC] = None + for cmd in self._commands: + if cmd.name == command_name or command_name in cmd.aliases: + command = self._services.get_service(cmd.command) + + if command is None: + Console.error(f'Invalid argument: {command_name}') + return + + Console.write_line(command.help_message) + + return + Console.write_line('Available Commands:') commands = [ + ['add (a|a)', 'Adds a project reference to given project.'], ['build (b|B)', 'Prepares files for publish into an output directory named dist/ at the given output path. Must be executed from within a workspace directory.'], ['generate (g|G)', 'Generate a new file.'], ['help (h|H)', 'Lists available command and their short descriptions.'], ['install (i|I)', 'With argument installs packages to project, without argument installs project dependencies.'], ['new (n|N)', 'Creates new CPL project.'], ['publish (p|P)', 'Prepares files for publish into an output directory named dist/ at the given output path and executes setup.py. Must be executed from within a library workspace directory.'], - ['start (s|S)', 'Starts CPL project, restarting on file changes'], + ['remove (r|R)', 'Removes a project from workspace.'], + ['start (s|S)', 'Starts CPL project, restarting on file changes.'], ['uninstall (ui|UI)', 'Uninstalls packages from project.'], ['update (u|u)', 'Update CPL and project dependencies.'], ['version (v|V)', 'Outputs CPL CLI version.'] diff --git a/src/cpl_cli/command/install_service.py b/src/cpl_cli/command/install_service.py index 494bb823..7f733e2f 100644 --- a/src/cpl_cli/command/install_service.py +++ b/src/cpl_cli/command/install_service.py @@ -1,9 +1,11 @@ import json import os import subprocess +import textwrap from packaging import version +from cpl.configuration.configuration_abc import ConfigurationABC from cpl.console.console import Console from cpl.console.foreground_color_enum import ForegroundColorEnum from cpl.environment.application_environment_abc import ApplicationEnvironmentABC @@ -18,10 +20,11 @@ from cpl_cli.error import Error class InstallService(CommandABC): - def __init__(self, env: ApplicationEnvironmentABC, build_settings: BuildSettings, project_settings: ProjectSettings, - cli_settings: CLISettings): + def __init__(self, config: ConfigurationABC, env: ApplicationEnvironmentABC, build_settings: BuildSettings, + project_settings: ProjectSettings, cli_settings: CLISettings): """ Service for the CLI command install + :param config: :param env: :param build_settings: :param project_settings: @@ -29,11 +32,24 @@ class InstallService(CommandABC): """ CommandABC.__init__(self) + self._config = config self._env = env self._build_settings = build_settings self._project_settings = project_settings self._cli_settings = cli_settings + self._project_file = f'{self._config.get_configuration("ProjectName")}.json' + + @property + def help_message(self) -> str: + return textwrap.dedent("""\ + Installs given package via pip + Usage: cpl install + + Arguments: + package The package to install + """) + def _install_project(self): """ Installs dependencies of CPl project @@ -45,7 +61,7 @@ class InstallService(CommandABC): return if self._project_settings.dependencies is None: - Error.error('Found invalid dependencies in cpl.json.') + Error.error(f'Found invalid dependencies in {self._project_file}.') return Pip.set_executable(self._project_settings.python_executable) @@ -76,7 +92,7 @@ class InstallService(CommandABC): return if self._project_settings.dependencies is None: - Error.error('Found invalid dependencies in cpl.json.') + Error.error(f'Found invalid dependencies in {self._project_file}.') return package_version = '' @@ -121,6 +137,7 @@ class InstallService(CommandABC): spinner_foreground_color=ForegroundColorEnum.cyan ) new_package = Pip.get_package(name) + Console.write_line(new_package) if new_package is None \ or '==' in package and \ version.parse(package.split('==')[1]) != version.parse(new_package.split('==')[1]): @@ -147,7 +164,7 @@ class InstallService(CommandABC): BuildSettings.__name__: SettingsHelper.get_build_settings_dict(self._build_settings) } - with open(os.path.join(self._env.working_directory, 'cpl.json'), 'w') as project_file: + with open(os.path.join(self._env.working_directory, self._project_file), 'w') as project_file: project_file.write(json.dumps(config, indent=2)) project_file.close() diff --git a/src/cpl_cli/command/new_service.py b/src/cpl_cli/command/new_service.py index 7b945c25..8c19b346 100644 --- a/src/cpl_cli/command/new_service.py +++ b/src/cpl_cli/command/new_service.py @@ -1,6 +1,6 @@ -import json import os import sys +import textwrap from typing import Optional from packaging import version @@ -18,6 +18,7 @@ from cpl_cli.configuration.project_settings import ProjectSettings from cpl_cli.configuration.project_settings_name_enum import ProjectSettingsNameEnum from cpl_cli.configuration.project_type_enum import ProjectTypeEnum from cpl_cli.configuration.version_settings_name_enum import VersionSettingsNameEnum +from cpl_cli.configuration.workspace_settings import WorkspaceSettings from cpl_cli.source_creator.console_builder import ConsoleBuilder from cpl_cli.source_creator.library_builder import LibraryBuilder @@ -34,6 +35,7 @@ class NewService(CommandABC): self._config = configuration self._env = self._config.environment + self._workspace = self._config.get_configuration(WorkspaceSettings) self._project: ProjectSettings = ProjectSettings() self._project_dict = {} self._build: BuildSettings = BuildSettings() @@ -45,6 +47,21 @@ class NewService(CommandABC): self._use_startup: bool = False self._use_service_providing: bool = False + @property + def help_message(self) -> str: + return textwrap.dedent("""\ + Generates a workspace and initial project or add a project to workspace. + Usage: cpl new + + Arguments: + type The project type of the initial project + name Name of the workspace or the project + + Types: + console + library + """) + @staticmethod def _help(message: str): """ @@ -93,12 +110,12 @@ class NewService(CommandABC): def _create_build_settings(self): main = f'{String.convert_to_snake_case(self._project.name)}.main' if self._command == ProjectTypeEnum.library.value: - main = f'{String.convert_to_snake_case(self._project.name)}_cli.main' + main = f'{String.convert_to_snake_case(self._project.name)}.main' self._build_dict = { BuildSettingsNameEnum.project_type.value: self._command, - BuildSettingsNameEnum.source_path.value: 'src', - BuildSettingsNameEnum.output_path.value: 'dist', + BuildSettingsNameEnum.source_path.value: '', + BuildSettingsNameEnum.output_path.value: '../../dist', BuildSettingsNameEnum.main.value: main, BuildSettingsNameEnum.entry_point.value: self._project.name, BuildSettingsNameEnum.include_package_data.value: False, @@ -108,7 +125,8 @@ class NewService(CommandABC): '*/logs', '*/tests' ], - BuildSettingsNameEnum.package_data.value: {} + BuildSettingsNameEnum.package_data.value: {}, + BuildSettingsNameEnum.project_references.value: [] } self._build.from_dict(self._build_dict) @@ -127,7 +145,15 @@ class NewService(CommandABC): Gets project path :return: """ - project_path = os.path.join(self._env.working_directory, self._project.name) + if self._workspace is None: + project_path = os.path.join(self._env.working_directory, self._project.name) + else: + project_path = os.path.join( + self._env.working_directory, + 'src', + String.convert_to_snake_case(self._project.name) + ) + if os.path.isdir(project_path) and len(os.listdir(project_path)) > 0: Console.error('Project path is not empty\n') return None @@ -176,7 +202,8 @@ class NewService(CommandABC): self._use_startup, self._use_service_providing, self._project.name, - self._project_json + self._project_json, + self._workspace ) except Exception as e: Console.error('Could not create project', str(e)) @@ -204,7 +231,8 @@ class NewService(CommandABC): self._use_startup, self._use_service_providing, self._project.name, - self._project_json + self._project_json, + self._workspace ) except Exception as e: Console.error('Could not create project', str(e)) diff --git a/src/cpl_cli/command/publish_service.py b/src/cpl_cli/command/publish_service.py index 7f459ea9..7a6403a4 100644 --- a/src/cpl_cli/command/publish_service.py +++ b/src/cpl_cli/command/publish_service.py @@ -1,4 +1,5 @@ -from cpl.console.console import Console +import textwrap + from cpl_cli.command_abc import CommandABC from cpl_cli.publish.publisher_abc import PublisherABC @@ -14,6 +15,13 @@ class PublishService(CommandABC): self._publisher = publisher + @property + def help_message(self) -> str: + return textwrap.dedent("""\ + Prepares files for publish into an output directory named dist/ at the given output path and executes setup.py. + Usage: cpl publish + """) + def run(self, args: list[str]): """ Entry point of command diff --git a/src/cpl_cli/command/remove_service.py b/src/cpl_cli/command/remove_service.py new file mode 100644 index 00000000..d826d907 --- /dev/null +++ b/src/cpl_cli/command/remove_service.py @@ -0,0 +1,99 @@ +import os +import shutil +import json +import textwrap + +from cpl.configuration.configuration_abc import ConfigurationABC +from cpl.console.console import Console +from cpl.console.foreground_color_enum import ForegroundColorEnum +from cpl.environment.application_environment_abc import ApplicationEnvironmentABC +from cpl_cli.command_abc import CommandABC +from cpl_cli.configuration import WorkspaceSettings, WorkspaceSettingsNameEnum + + +class RemoveService(CommandABC): + + def __init__(self, config: ConfigurationABC, env: ApplicationEnvironmentABC): + """ + Service for CLI command remove + :param config: + :param env: + """ + CommandABC.__init__(self) + + self._config = config + self._env = env + + self._workspace: WorkspaceSettings = self._config.get_configuration(WorkspaceSettings) + + @property + def help_message(self) -> str: + return textwrap.dedent("""\ + Removes a project from workspace. + Usage: cpl remove + + Arguments: + project The name of the project to delete + """) + + @staticmethod + def _create_file(file_name: str, content: dict): + if not os.path.isabs(file_name): + file_name = os.path.abspath(file_name) + + path = os.path.dirname(file_name) + if not os.path.isdir(path): + os.makedirs(path) + + with open(file_name, 'w') as project_json: + project_json.write(json.dumps(content, indent=2)) + project_json.close() + + @staticmethod + def _remove_sources(path: str): + shutil.rmtree(path) + + def _create_workspace(self, path: str): + ws_dict = { + WorkspaceSettings.__name__: { + WorkspaceSettingsNameEnum.default_project.value: self._workspace.default_project, + WorkspaceSettingsNameEnum.projects.value: self._workspace.projects + } + } + + self._create_file(path, ws_dict) + + def run(self, args: list[str]): + """ + Entry point of command + :param args: + :return: + """ + + project_name = args[0] + if project_name not in self._workspace.projects: + Console.error(f'Project {project_name} not found in workspace.') + return + + if project_name == self._workspace.default_project: + Console.error(f'Project {project_name} is the default project.') + return + + src_path = os.path.abspath(os.path.dirname(self._workspace.projects[project_name])) + Console.spinner( + f'Removing {src_path}', + self._remove_sources, + src_path, + text_foreground_color=ForegroundColorEnum.green, + spinner_foreground_color=ForegroundColorEnum.cyan + ) + + del self._workspace.projects[project_name] + path = 'cpl-workspace.json' + Console.spinner( + f'Changing {path}', + self._create_workspace, + path, + text_foreground_color=ForegroundColorEnum.green, + spinner_foreground_color=ForegroundColorEnum.cyan + ) diff --git a/src/cpl_cli/command/start_service.py b/src/cpl_cli/command/start_service.py index 7dae7086..48b853b4 100644 --- a/src/cpl_cli/command/start_service.py +++ b/src/cpl_cli/command/start_service.py @@ -1,3 +1,5 @@ +import textwrap + from cpl_cli.command_abc import CommandABC from cpl_cli.live_server.live_server_service import LiveServerService @@ -13,10 +15,17 @@ class StartService(CommandABC): self._live_server = live_server + @property + def help_message(self) -> str: + return textwrap.dedent("""\ + Starts your application, restarting on file changes. + Usage: cpl start + """) + def run(self, args: list[str]): """ Entry point of command :param args: :return: """ - self._live_server.start() + self._live_server.start(args) diff --git a/src/cpl_cli/command/uninstall_service.py b/src/cpl_cli/command/uninstall_service.py index da7ea3ca..4c9944c6 100644 --- a/src/cpl_cli/command/uninstall_service.py +++ b/src/cpl_cli/command/uninstall_service.py @@ -1,7 +1,9 @@ import json import os import subprocess +import textwrap +from cpl.configuration.configuration_abc import ConfigurationABC from cpl.console.console import Console from cpl.console.foreground_color_enum import ForegroundColorEnum from cpl.environment.application_environment_abc import ApplicationEnvironmentABC @@ -14,21 +16,32 @@ from cpl_cli.configuration.settings_helper import SettingsHelper class UninstallService(CommandABC): - def __init__(self, env: ApplicationEnvironmentABC, build_settings: BuildSettings, + def __init__(self, config: ConfigurationABC, env: ApplicationEnvironmentABC, build_settings: BuildSettings, project_settings: ProjectSettings): """ Service for the CLI command uninstall + :param config: :param env: :param build_settings: :param project_settings: """ CommandABC.__init__(self) + self._config = config self._env = env - self._build_settings = build_settings self._project_settings = project_settings + @property + def help_message(self) -> str: + return textwrap.dedent("""\ + Uninstalls given package via pip + Usage: cpl uninstall + + Arguments: + package The package to uninstall + """) + def run(self, args: list[str]): """ Entry point of command @@ -74,7 +87,7 @@ class UninstallService(CommandABC): ProjectSettings.__name__: SettingsHelper.get_project_settings_dict(self._project_settings), BuildSettings.__name__: SettingsHelper.get_build_settings_dict(self._build_settings) } - with open(os.path.join(self._env.working_directory, 'cpl.json'), 'w') as project_file: + with open(os.path.join(self._env.working_directory, f'{self._config.get_configuration("ProjectName")}.json'), 'w') as project_file: project_file.write(json.dumps(config, indent=2)) project_file.close() diff --git a/src/cpl_cli/command/update_service.py b/src/cpl_cli/command/update_service.py index c45679bd..5cfb52de 100644 --- a/src/cpl_cli/command/update_service.py +++ b/src/cpl_cli/command/update_service.py @@ -1,7 +1,9 @@ import json import os import subprocess +import textwrap +from cpl.configuration.configuration_abc import ConfigurationABC from cpl.console.console import Console from cpl.console.foreground_color_enum import ForegroundColorEnum from cpl.environment.application_environment_abc import ApplicationEnvironmentABC @@ -16,12 +18,14 @@ from cpl_cli.configuration.settings_helper import SettingsHelper class UpdateService(CommandABC): def __init__(self, + config: ConfigurationABC, env: ApplicationEnvironmentABC, build_settings: BuildSettings, project_settings: ProjectSettings, cli_settings: CLISettings): """ Service for the CLI command update + :param config: :param env: :param build_settings: :param project_settings: @@ -29,11 +33,19 @@ class UpdateService(CommandABC): """ CommandABC.__init__(self) + self._config = config self._env = env self._build_settings = build_settings self._project_settings = project_settings self._cli_settings = cli_settings + @property + def help_message(self) -> str: + return textwrap.dedent("""\ + Updates the CPL and project dependencies. + Usage: cpl update + """) + def _collect_project_dependencies(self) -> list[tuple]: """ Collects project dependencies @@ -115,7 +127,7 @@ class UpdateService(CommandABC): def _project_json_update_dependency(self, old_package: str, new_package: str): """ - Writes new package version to cpl.json + Writes new package version to project.json :param old_package: :param new_package: :return: @@ -135,7 +147,8 @@ class UpdateService(CommandABC): BuildSettings.__name__: SettingsHelper.get_build_settings_dict(self._build_settings) } - with open(os.path.join(self._env.working_directory, 'cpl.json'), 'w') as project: + with open(os.path.join(self._env.working_directory, f'{self._config.get_configuration("ProjectName")}.json'), + 'w') as project: project.write(json.dumps(config, indent=2)) project.close() diff --git a/src/cpl_cli/command/version_service.py b/src/cpl_cli/command/version_service.py index 0046a3f9..5afadbd2 100644 --- a/src/cpl_cli/command/version_service.py +++ b/src/cpl_cli/command/version_service.py @@ -2,6 +2,7 @@ import pkgutil import sys import platform import pkg_resources +import textwrap import cpl import cpl_cli @@ -18,6 +19,13 @@ class VersionService(CommandABC): """ CommandABC.__init__(self) + @property + def help_message(self) -> str: + return textwrap.dedent("""\ + Lists the version of CPL, CPL CLI and all installed packages from pip. + Usage: cpl version + """) + def run(self, args: list[str]): """ Entry point of command diff --git a/src/cpl_cli/command_abc.py b/src/cpl_cli/command_abc.py index 6ac6376f..9cdfd84b 100644 --- a/src/cpl_cli/command_abc.py +++ b/src/cpl_cli/command_abc.py @@ -7,5 +7,9 @@ class CommandABC(ABC): def __init__(self): ABC.__init__(self) + @property + @abstractmethod + def help_message(self) -> str: pass + @abstractmethod def run(self, args: list[str]): pass diff --git a/src/cpl_cli/command_handler_service.py b/src/cpl_cli/command_handler_service.py index 75bcdced..852345fd 100644 --- a/src/cpl_cli/command_handler_service.py +++ b/src/cpl_cli/command_handler_service.py @@ -1,9 +1,12 @@ import os from abc import ABC +from typing import Optional from cpl.configuration.configuration_abc import ConfigurationABC from cpl.console.console import Console from cpl.dependency_injection.service_provider_abc import ServiceProviderABC +from cpl.utils.string import String +from cpl_cli.configuration.workspace_settings import WorkspaceSettings from cpl_cli.error import Error from cpl_cli.command_model import CommandModel @@ -28,6 +31,12 @@ class CommandHandler(ABC): def commands(self) -> list[CommandModel]: return self._commands + @staticmethod + def _project_not_found(): + Error.error( + 'The command requires to be run in an CPL project, but a project could not be found.' + ) + def add_command(self, cmd: CommandModel): self._commands.append(cmd) @@ -43,12 +52,64 @@ class CommandHandler(ABC): """ for command in self._commands: if cmd == command.name or cmd in command.aliases: - if command.is_project_needed and not os.path.isfile(os.path.join(self._env.working_directory, 'cpl.json')): - Error.error('The command requires to be run in an CPL project, but a project could not be found.') - return + error = None + project_name: Optional[str] = None + workspace: Optional[WorkspaceSettings] = None + + if os.path.isfile(os.path.join(self._env.working_directory, 'cpl-workspace.json')): + self._config.add_json_file('cpl-workspace.json', optional=True, output=False) + workspace = self._config.get_configuration(WorkspaceSettings) if command.is_project_needed: - self._config.add_json_file('cpl.json', optional=True, output=False) + name = os.path.basename(self._env.working_directory) + for r, d, f in os.walk(self._env.working_directory): + for file in f: + if file.endswith('.json'): + f_name = file.split('.json')[0] + if f_name == name or \ + String.convert_to_camel_case(f_name).lower() == String.convert_to_camel_case( + name).lower(): + project_name = f_name + break + + if not command.is_workspace_needed and project_name is None and workspace is None: + self._project_not_found() + return + + elif command.is_workspace_needed or project_name is None: + if workspace is None: + Error.error( + 'The command requires to be run in an CPL workspace or project, ' + 'but a workspace or project could not be found.' + ) + return + + if project_name is None: + project_name = workspace.default_project + + self._config.add_configuration('ProjectName', project_name) + project_json = f'{project_name}.json' + + if workspace is not None: + if project_name not in workspace.projects: + Error.error( + f'Project {project_name} not found.' + ) + return + project_json = workspace.projects[project_name] + + if not os.path.isfile(os.path.join(self._env.working_directory, project_json)): + self._project_not_found() + return + + project_json = os.path.join(self._env.working_directory, project_json) + + if command.change_cwd: + self._env.set_working_directory( + os.path.join(self._env.working_directory, os.path.dirname(project_json)) + ) + + self._config.add_json_file(project_json, optional=True, output=False) self._services.get_service(command.command).run(args) Console.write('\n') diff --git a/src/cpl_cli/command_model.py b/src/cpl_cli/command_model.py index 85afe007..5fabea2a 100644 --- a/src/cpl_cli/command_model.py +++ b/src/cpl_cli/command_model.py @@ -5,11 +5,14 @@ from cpl_cli.command_abc import CommandABC class CommandModel: - def __init__(self, name: str, aliases: list[str], command: Callable[CommandABC], is_project_needed: bool): + def __init__(self, name: str, aliases: list[str], command: Callable[CommandABC], is_workspace_needed: bool, + is_project_needed: bool, change_cwd: bool): self._name = name self._aliases = aliases self._command = command + self._is_workspace_needed = is_workspace_needed self._is_project_needed = is_project_needed + self._change_cwd = change_cwd @property def name(self) -> str: @@ -18,11 +21,19 @@ class CommandModel: @property def aliases(self) -> list[str]: return self._aliases - + @property def command(self) -> Callable[CommandABC]: return self._command + @property + def is_workspace_needed(self) -> bool: + return self._is_workspace_needed + @property def is_project_needed(self) -> bool: return self._is_project_needed + + @property + def change_cwd(self) -> bool: + return self._change_cwd diff --git a/src/cpl_cli/configuration/__init__.py b/src/cpl_cli/configuration/__init__.py index 4144b72d..cf04a476 100644 --- a/src/cpl_cli/configuration/__init__.py +++ b/src/cpl_cli/configuration/__init__.py @@ -1,10 +1,10 @@ # -*- coding: utf-8 -*- """ -sh_cpl sh-edraft Common Python library +sh_cpl-cli sh-edraft Common Python library CLI ~~~~~~~~~~~~~~~~~~~ -sh-edraft Common Python library +sh-edraft Common Python library Command Line Interface :copyright: (c) 2020 - 2021 sh-edraft.de :license: MIT, see LICENSE for more details. @@ -15,7 +15,7 @@ __title__ = 'cpl_cli.configuration' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple @@ -26,6 +26,8 @@ from .project_settings import ProjectSettings from .project_settings_name_enum import ProjectSettingsNameEnum from .version_settings import VersionSettings from .version_settings_name_enum import VersionSettingsNameEnum +from .workspace_settings import WorkspaceSettings +from .workspace_settings_name_enum import WorkspaceSettingsNameEnum VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl_cli/configuration/build_settings.py b/src/cpl_cli/configuration/build_settings.py index f24be025..167db345 100644 --- a/src/cpl_cli/configuration/build_settings.py +++ b/src/cpl_cli/configuration/build_settings.py @@ -23,6 +23,7 @@ class BuildSettings(ConfigurationModelABC): self._included: Optional[list[str]] = None self._excluded: Optional[list[str]] = None self._package_data: Optional[dict[str, list[str]]] = None + self._project_references: Optional[list[str]] = None @property def project_type(self): @@ -60,6 +61,10 @@ class BuildSettings(ConfigurationModelABC): def package_data(self) -> dict[str, list[str]]: return self._package_data + @property + def project_references(self) -> list[str]: + return self._project_references + def from_dict(self, settings: dict): try: self._project_type = settings[BuildSettingsNameEnum.project_type.value] @@ -71,6 +76,7 @@ class BuildSettings(ConfigurationModelABC): self._included = settings[BuildSettingsNameEnum.included.value] self._excluded = settings[BuildSettingsNameEnum.excluded.value] self._package_data = settings[BuildSettingsNameEnum.package_data.value] + self._project_references = settings[BuildSettingsNameEnum.project_references.value] if sys.platform == 'win32': self._source_path = str(self._source_path).replace('/', '\\') diff --git a/src/cpl_cli/configuration/build_settings_name_enum.py b/src/cpl_cli/configuration/build_settings_name_enum.py index 18d78749..5c0dee28 100644 --- a/src/cpl_cli/configuration/build_settings_name_enum.py +++ b/src/cpl_cli/configuration/build_settings_name_enum.py @@ -12,3 +12,4 @@ class BuildSettingsNameEnum(Enum): included = 'Included' excluded = 'Excluded' package_data = 'PackageData' + project_references = 'ProjectReferences' diff --git a/src/cpl_cli/configuration/settings_helper.py b/src/cpl_cli/configuration/settings_helper.py index e4229445..8a7c47ad 100644 --- a/src/cpl_cli/configuration/settings_helper.py +++ b/src/cpl_cli/configuration/settings_helper.py @@ -42,5 +42,6 @@ class SettingsHelper: BuildSettingsNameEnum.include_package_data.value: build.include_package_data, BuildSettingsNameEnum.included.value: build.included, BuildSettingsNameEnum.excluded.value: build.excluded, - BuildSettingsNameEnum.package_data.value: build.package_data + BuildSettingsNameEnum.package_data.value: build.package_data, + BuildSettingsNameEnum.project_references.value: build.project_references } diff --git a/src/cpl_cli/configuration/version_settings.py b/src/cpl_cli/configuration/version_settings.py index 3d64d71e..86fac84c 100644 --- a/src/cpl_cli/configuration/version_settings.py +++ b/src/cpl_cli/configuration/version_settings.py @@ -31,16 +31,25 @@ class VersionSettings(ConfigurationModelABC): return self._micro def to_str(self) -> str: - return f'{self._major}.{self._minor}.{self._micro}' + if self._micro is None: + return f'{self._major}.{self._minor}' + else: + return f'{self._major}.{self._minor}.{self._micro}' def from_dict(self, settings: dict): self._major = settings[VersionSettingsNameEnum.major.value] self._minor = settings[VersionSettingsNameEnum.minor.value] - self._micro = settings[VersionSettingsNameEnum.micro.value] + micro = settings[VersionSettingsNameEnum.micro.value] + if micro != '': + self._micro = micro def to_dict(self) -> dict: - return { + version = { VersionSettingsNameEnum.major.value: self._major, VersionSettingsNameEnum.minor.value: self._minor, - VersionSettingsNameEnum.micro.value: self._micro } + + if self._micro is not None: + version[VersionSettingsNameEnum.micro.value] = self._micro + + return version diff --git a/src/cpl_cli/configuration/workspace_settings.py b/src/cpl_cli/configuration/workspace_settings.py new file mode 100644 index 00000000..ff40999a --- /dev/null +++ b/src/cpl_cli/configuration/workspace_settings.py @@ -0,0 +1,31 @@ +import traceback +from typing import Optional + +from cpl.configuration.configuration_model_abc import ConfigurationModelABC +from cpl.console import Console +from cpl_cli.configuration.workspace_settings_name_enum import WorkspaceSettingsNameEnum + + +class WorkspaceSettings(ConfigurationModelABC): + + def __init__(self): + ConfigurationModelABC.__init__(self) + + self._default_project: Optional[str] = None + self._projects: dict[str, str] = {} + + @property + def default_project(self) -> str: + return self._default_project + + @property + def projects(self) -> dict[str, str]: + return self._projects + + def from_dict(self, settings: dict): + try: + self._default_project = settings[WorkspaceSettingsNameEnum.default_project.value] + self._projects = settings[WorkspaceSettingsNameEnum.projects.value] + except Exception as e: + Console.error(f'[ ERROR ] [ {__name__} ]: Reading error in {self.__name__} settings') + Console.error(f'[ EXCEPTION ] [ {__name__} ]: {e} -> {traceback.format_exc()}') diff --git a/src/cpl_cli/configuration/workspace_settings_name_enum.py b/src/cpl_cli/configuration/workspace_settings_name_enum.py new file mode 100644 index 00000000..57bbdd20 --- /dev/null +++ b/src/cpl_cli/configuration/workspace_settings_name_enum.py @@ -0,0 +1,7 @@ +from enum import Enum + + +class WorkspaceSettingsNameEnum(Enum): + + default_project = 'DefaultProject' + projects = 'Projects' diff --git a/src/cpl_cli/cpl_cli.json b/src/cpl_cli/cpl_cli.json new file mode 100644 index 00000000..9c52b436 --- /dev/null +++ b/src/cpl_cli/cpl_cli.json @@ -0,0 +1,47 @@ +{ + "ProjectSettings": { + "Name": "sh_cpl-cli", + "Version": { + "Major": "2021", + "Minor": "4", + "Micro": "0.post1" + }, + "Author": "Sven Heidemann", + "AuthorEmail": "sven.heidemann@sh-edraft.de", + "Description": "sh-edraft Common Python library CLI", + "LongDescription": "sh-edraft Common Python library Command Line Interface", + "URL": "https://www.sh-edraft.de", + "CopyrightDate": "2020 - 2021", + "CopyrightName": "sh-edraft.de", + "LicenseName": "MIT", + "LicenseDescription": "MIT, see LICENSE for more details.", + "Dependencies": [ + "sh_cpl==2021.4.1.rc2" + ], + "PythonVersion": ">=3.8", + "PythonPath": {}, + "Classifiers": [] + }, + "BuildSettings": { + "ProjectType": "console", + "SourcePath": "", + "OutputPath": "../../dist", + "Main": "cpl_cli.main", + "EntryPoint": "cpl", + "IncludePackageData": true, + "Included": [ + "*/_templates" + ], + "Excluded": [ + "*/__pycache__", + "*/logs", + "*/tests" + ], + "PackageData": { + "cpl_cli": [ + "*.json" + ] + }, + "ProjectReferences": [] + } +} \ No newline at end of file diff --git a/src/cpl_cli/live_server/__init__.py b/src/cpl_cli/live_server/__init__.py index aeb9ebfb..8df4a863 100644 --- a/src/cpl_cli/live_server/__init__.py +++ b/src/cpl_cli/live_server/__init__.py @@ -1,10 +1,10 @@ # -*- coding: utf-8 -*- """ -sh_cpl sh-edraft Common Python library +sh_cpl-cli sh-edraft Common Python library CLI ~~~~~~~~~~~~~~~~~~~ -sh-edraft Common Python library +sh-edraft Common Python library Command Line Interface :copyright: (c) 2020 - 2021 sh-edraft.de :license: MIT, see LICENSE for more details. @@ -15,11 +15,11 @@ __title__ = 'cpl_cli.live_server' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple # imports: VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl_cli/live_server/live_server_service.py b/src/cpl_cli/live_server/live_server_service.py index 9005ae50..d837f4e3 100644 --- a/src/cpl_cli/live_server/live_server_service.py +++ b/src/cpl_cli/live_server/live_server_service.py @@ -9,26 +9,32 @@ from watchdog.observers import Observer from cpl.console.console import Console from cpl.environment.application_environment_abc import ApplicationEnvironmentABC from cpl_cli.configuration.build_settings import BuildSettings +from cpl_cli.configuration.project_settings import ProjectSettings from cpl_cli.live_server.live_server_thread import LiveServerThread class LiveServerService(FileSystemEventHandler): - def __init__(self, env: ApplicationEnvironmentABC, build_settings: BuildSettings): + def __init__(self, env: ApplicationEnvironmentABC, project_settings: ProjectSettings, + build_settings: BuildSettings): """ Service for the live development server :param env: + :param project_settings: :param build_settings: """ FileSystemEventHandler.__init__(self) self._env = env + self._project_settings = project_settings self._build_settings = build_settings self._src_dir = os.path.join(self._env.working_directory, self._build_settings.source_path) self._ls_thread = None self._observer = None + self._args: list[str] = [] + def _start_observer(self): """ Starts the file changes observer @@ -70,15 +76,27 @@ class LiveServerService(FileSystemEventHandler): def _start(self): self._start_observer() - self._ls_thread = LiveServerThread(self._src_dir, self._build_settings) + self._ls_thread = LiveServerThread( + self._project_settings.python_executable, + self._src_dir, + self._args, + self._env, + self._build_settings + ) self._ls_thread.start() self._ls_thread.join() Console.close() - def start(self): + def start(self, args: list[str]): """ Starts the CPL live development server + :param args: :return: """ + if self._build_settings.main == '': + Console.error('Project has no entry point.') + return + + self._args = args Console.write_line('** CPL live development server is running **') self._start() diff --git a/src/cpl_cli/live_server/live_server_thread.py b/src/cpl_cli/live_server/live_server_thread.py index 172d4e0d..0a32b5c1 100644 --- a/src/cpl_cli/live_server/live_server_thread.py +++ b/src/cpl_cli/live_server/live_server_thread.py @@ -6,23 +6,36 @@ from datetime import datetime from cpl.console.console import Console from cpl.console.foreground_color_enum import ForegroundColorEnum +from cpl.environment.application_environment_abc import ApplicationEnvironmentABC from cpl_cli.configuration import BuildSettings class LiveServerThread(threading.Thread): - def __init__(self, path: str, build_settings: BuildSettings): + def __init__(self, executable: str, path: str, args: list[str], env: ApplicationEnvironmentABC, + build_settings: BuildSettings): """ Thread to start the CPL project for the live development server + :param executable: :param path: + :param args: + :param env: + :param build_settings: """ threading.Thread.__init__(self) + self._executable = os.path.abspath(executable) + self._path = path + self._args = args + self._env = env self._build_settings = build_settings self._main = '' self._command = [] + self._env_vars = os.environ + + self._set_venv() @property def command(self) -> list[str]: @@ -32,17 +45,40 @@ class LiveServerThread(threading.Thread): def main(self) -> str: return self._main + def _set_venv(self): + if self._executable != sys.executable: + path = os.path.abspath(os.path.dirname(os.path.dirname(self._executable))) + if sys.platform == 'win32': + self._env_vars['PATH'] = f'{path}\\bin' + os.pathsep + os.environ.get('PATH', '') + else: + self._env_vars['PATH'] = f'{path}/bin' + os.pathsep + os.environ.get('PATH', '') + + self._env_vars['VIRTUAL_ENV'] = path + def run(self): """ Starts the CPL project :return: """ - main = self._build_settings.main.replace('.', '/') + main = self._build_settings.main + if '.' in self._build_settings.main: + length = len(self._build_settings.main.split('.')) - 1 + main = self._build_settings.main.split('.')[length] + self._main = os.path.join(self._path, f'{main}.py') if not os.path.isfile(self._main): Console.error('Entry point main.py not found') return + # set cwd to src/ + self._env.set_working_directory(os.path.abspath(os.path.join(self._path, '../'))) + if sys.platform == 'win32': + self._env_vars['PYTHONPATH'] = f'{self._env.working_directory};' \ + f'{os.path.join(self._env.working_directory, self._build_settings.source_path)}' + else: + self._env_vars['PYTHONPATH'] = f'{self._env.working_directory}:' \ + f'{os.path.join(self._env.working_directory, self._build_settings.source_path)}' + Console.set_foreground_color(ForegroundColorEnum.green) Console.write_line('Read successfully') Console.set_foreground_color(ForegroundColorEnum.cyan) @@ -50,13 +86,6 @@ class LiveServerThread(threading.Thread): Console.write_line(f'Started at {now.strftime("%Y-%m-%d %H:%M:%S")}\n\n') Console.set_foreground_color(ForegroundColorEnum.default) - env_vars = os.environ - if sys.platform == 'win32': - env_vars['PYTHONPATH'] = f'{os.path.dirname(self._path)};' \ - f'{os.path.join(os.path.dirname(self._path), self._build_settings.source_path)}' - else: - env_vars['PYTHONPATH'] = f'{os.path.dirname(self._path)}:' \ - f'{os.path.join(os.path.dirname(self._path), self._build_settings.source_path)}' - - self._command = [sys.executable, self._main, ''.join(sys.argv[2:])] - subprocess.run(self._command, env=env_vars) + os.chdir(self._env.working_directory) + self._command = [self._executable, self._main, ''.join(self._args)] + subprocess.run(self._command, env=self._env_vars) diff --git a/src/cpl_cli/publish/__init__.py b/src/cpl_cli/publish/__init__.py index bd94bec5..d496cfb7 100644 --- a/src/cpl_cli/publish/__init__.py +++ b/src/cpl_cli/publish/__init__.py @@ -1,10 +1,10 @@ # -*- coding: utf-8 -*- """ -sh_cpl sh-edraft Common Python library +sh_cpl-cli sh-edraft Common Python library CLI ~~~~~~~~~~~~~~~~~~~ -sh-edraft Common Python library +sh-edraft Common Python library Command Line Interface :copyright: (c) 2020 - 2021 sh-edraft.de :license: MIT, see LICENSE for more details. @@ -15,7 +15,7 @@ __title__ = 'cpl_cli.publish' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple @@ -24,4 +24,4 @@ from .publisher_abc import PublisherABC from .publisher_service import PublisherService VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl_cli/publish/publisher_service.py b/src/cpl_cli/publish/publisher_service.py index 95f8e0cc..f4187783 100644 --- a/src/cpl_cli/publish/publisher_service.py +++ b/src/cpl_cli/publish/publisher_service.py @@ -7,27 +7,31 @@ import setuptools from packaging import version from setuptools import sandbox +from cpl.configuration.configuration_abc import ConfigurationABC from cpl.console.foreground_color_enum import ForegroundColorEnum from cpl.console.console import Console from cpl.environment.application_environment_abc import ApplicationEnvironmentABC from cpl_cli.configuration.build_settings import BuildSettings from cpl_cli.configuration.project_settings import ProjectSettings from cpl_cli.publish.publisher_abc import PublisherABC -from cpl_cli.templates.build.init_template import InitTemplate -from cpl_cli.templates.publish.setup_template import SetupTemplate +from cpl_cli._templates.build.init_template import InitTemplate +from cpl_cli._templates.publish.setup_template import SetupTemplate class PublisherService(PublisherABC): - def __init__(self, env: ApplicationEnvironmentABC, project: ProjectSettings, build: BuildSettings): + def __init__(self, config: ConfigurationABC, + env: ApplicationEnvironmentABC, project: ProjectSettings, build: BuildSettings): """ Service to build or publish files for distribution + :param config: :param env: :param project: :param build: """ PublisherABC.__init__(self) + self._config = config self._env = env self._project_settings = project self._build_settings = build @@ -130,6 +134,43 @@ class PublisherService(PublisherABC): return False + def _is_file_excluded(self, file: str) -> bool: + """ + Checks if the file is excluded + :param file: + :return: + """ + for excluded in self._build_settings.excluded: + if excluded.startswith('*'): + excluded = excluded.replace('*', '') + + if excluded in file and not self._is_path_included(file): + return True + + return False + + def _read_sources_from_path(self, path: str): + """ + Reads all source files from given path + :param path: + :return: + """ + for r, d, f in os.walk(path): + for file in f: + relative_path = os.path.relpath(r) + file_path = os.path.join(relative_path, os.path.relpath(file)) + if self._is_file_excluded(file_path): + continue + + if len(d) > 0: + for directory in d: + empty_dir = os.path.join(os.path.dirname(file_path), directory) + if len(os.listdir(empty_dir)) == 0: + self._included_dirs.append(empty_dir) + + if not self._is_path_excluded(relative_path): + self._included_files.append(os.path.relpath(file_path)) + def _read_sources(self): """ Reads all source files and save included files @@ -148,21 +189,16 @@ class PublisherService(PublisherABC): elif os.path.isfile(rel_path): self._included_files.append(rel_path) - for r, d, f in os.walk(self._build_settings.source_path): - for file in f: - relative_path = os.path.relpath(r) - file_path = os.path.join(relative_path, os.path.relpath(file)) - if self._is_path_excluded(relative_path): - break + self._read_sources_from_path(self._source_path) - if len(d) > 0: - for directory in d: - empty_dir = os.path.join(os.path.dirname(file_path), directory) - if len(os.listdir(empty_dir)) == 0: - self._included_dirs.append(empty_dir) + for project in self._build_settings.project_references: + project = os.path.abspath(os.path.join(self._source_path, project)) + if not os.path.isfile(os.path.abspath(project)): + Console.error(f'Cannot import project: {project}') + return - if not self._is_path_excluded(relative_path): - self._included_files.append(os.path.relpath(file_path)) + self.exclude(f'*/{os.path.basename(project)}') + self._read_sources_from_path(os.path.dirname(project)) def _create_packages(self): """ @@ -177,8 +213,6 @@ class PublisherService(PublisherABC): title = self._get_module_name_from_dirs(file) if title == '': title = self._project_settings.name - elif not title.__contains__('.'): - title = f'{self._project_settings.name}.{title}' module_py_lines: list[str] = [] imports = '' @@ -289,31 +323,39 @@ class PublisherService(PublisherABC): if os.path.isfile(setup_file): os.remove(setup_file) - main = None - try: - main_name = self._build_settings.main + entry_points = {} + if self._build_settings.main != "": + main = None + try: + main_name = self._build_settings.main - if '.' in self._build_settings.main: - length = len(self._build_settings.main.split('.')) - main_name = self._build_settings.main.split('.')[length - 1] + if '.' in self._build_settings.main: + length = len(self._build_settings.main.split('.')) + main_name = self._build_settings.main.split('.')[length - 1] - sys.path.insert(0, self._source_path) - main_mod = __import__(self._build_settings.main) - main = getattr(main_mod, main_name) - except Exception as e: - Console.error('Could not find entry point', str(e)) - return + sys.path.insert(0, self._source_path) + main_mod = __import__(self._build_settings.main) + main = getattr(main_mod, main_name) + except Exception as e: + Console.error('Could not find entry point', str(e)) + return - if main is None or not callable(main) and not hasattr(main, 'main'): - Console.error('Could not find entry point') - return + if main is None or not callable(main) and not hasattr(main, 'main'): + Console.error('Could not find entry point') + return - if callable(main): - mod_name = main.__module__ - func_name = main.__name__ - else: - mod_name = main.__name__ - func_name = main.main.__name__ + if callable(main): + mod_name = main.__module__ + func_name = main.__name__ + else: + mod_name = main.__name__ + func_name = main.main.__name__ + + entry_points = { + 'console_scripts': [ + f'{self._build_settings.entry_point} = {mod_name}:{func_name}' + ] + } with open(setup_file, 'w+') as setup_py: setup_string = stringTemplate(SetupTemplate.get_setup_py()).substitute( @@ -328,11 +370,7 @@ class PublisherService(PublisherABC): Description=self._project_settings.description, PyRequires=self._project_settings.python_version, Dependencies=self._project_settings.dependencies, - EntryPoints={ - 'console_scripts': [ - f'{self._build_settings.entry_point} = {mod_name}:{func_name}' - ] - }, + EntryPoints=entry_points, PackageData=self._build_settings.package_data ) setup_py.write(setup_string) @@ -385,7 +423,9 @@ class PublisherService(PublisherABC): 3. Copies all included source files to dist_path/build :return: """ - self._output_path = os.path.join(self._output_path, 'build') + self._env.set_working_directory(os.path.join(self._env.working_directory, '../')) + self.exclude(f'*/{self._config.get_configuration("ProjectName")}.json') + self._output_path = os.path.abspath(os.path.join(self._output_path, self._project_settings.name, 'build')) Console.spinner('Reading source files:', self._read_sources, text_foreground_color=ForegroundColorEnum.green, spinner_foreground_color=ForegroundColorEnum.blue) @@ -405,7 +445,9 @@ class PublisherService(PublisherABC): 4. Remove all included source from dist_path/publish :return: """ - self._output_path = os.path.join(self._output_path, 'publish') + self._env.set_working_directory(os.path.join(self._env.working_directory, '../')) + self.exclude(f'*/{self._config.get_configuration("ProjectName")}.json') + self._output_path = os.path.abspath(os.path.join(self._output_path, self._project_settings.name, 'publish')) Console.write_line('Build:') Console.spinner( diff --git a/src/cpl_cli/source_creator/__init__.py b/src/cpl_cli/source_creator/__init__.py index 2b9b45a1..147762a9 100644 --- a/src/cpl_cli/source_creator/__init__.py +++ b/src/cpl_cli/source_creator/__init__.py @@ -1,10 +1,10 @@ # -*- coding: utf-8 -*- """ -sh_cpl sh-edraft Common Python library +sh_cpl-cli sh-edraft Common Python library CLI ~~~~~~~~~~~~~~~~~~~ -sh-edraft Common Python library +sh-edraft Common Python library Command Line Interface :copyright: (c) 2020 - 2021 sh-edraft.de :license: MIT, see LICENSE for more details. @@ -15,11 +15,11 @@ __title__ = 'cpl_cli.source_creator' __author__ = 'Sven Heidemann' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' +__version__ = '2021.4.0.post1' from collections import namedtuple # imports: VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') +version_info = VersionInfo(major='2021', minor='4', micro='0.post1') diff --git a/src/cpl_cli/source_creator/console_builder.py b/src/cpl_cli/source_creator/console_builder.py index 8d6ad878..2e321b37 100644 --- a/src/cpl_cli/source_creator/console_builder.py +++ b/src/cpl_cli/source_creator/console_builder.py @@ -1,18 +1,23 @@ import json import os +from typing import Optional + from cpl.console.foreground_color_enum import ForegroundColorEnum from cpl.console.console import Console +from cpl.utils.string import String +from cpl_cli.configuration.workspace_settings import WorkspaceSettings +from cpl_cli.configuration.workspace_settings_name_enum import WorkspaceSettingsNameEnum from cpl_cli.source_creator.template_builder import TemplateBuilder -from cpl_cli.templates.new.console.appsettings_json import AppsettingsTemplate -from cpl_cli.templates.new.console.license import LicenseTemplate -from cpl_cli.templates.new.console.readme_py import ReadmeTemplate -from cpl_cli.templates.new.console.src.name.application import ApplicationTemplate -from cpl_cli.templates.new.console.src.name.init import MainInitTemplate -from cpl_cli.templates.new.console.src.name.main import MainWithApplicationHostAndStartupTemplate, \ +from cpl_cli._templates.new.console.appsettings_json import AppsettingsTemplate +from cpl_cli._templates.new.console.license import LicenseTemplate +from cpl_cli._templates.new.console.readme_py import ReadmeTemplate +from cpl_cli._templates.new.console.source.name.application import ApplicationTemplate +from cpl_cli._templates.new.console.source.name.init import MainInitTemplate +from cpl_cli._templates.new.console.source.name.main import MainWithApplicationHostAndStartupTemplate, \ MainWithoutApplicationBaseTemplate, MainWithApplicationBaseTemplate, MainWithDependencyInjection -from cpl_cli.templates.new.console.src.name.startup import StartupTemplate -from cpl_cli.templates.new.console.src.tests.init import TestsInitTemplate -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.new.console.source.name.startup import StartupTemplate +from cpl_cli._templates.new.console.source.tests.init import TestsInitTemplate +from cpl_cli._templates.template_file_abc import TemplateFileABC class ConsoleBuilder: @@ -21,8 +26,39 @@ class ConsoleBuilder: pass @staticmethod - def build(project_path: str, use_application_api: bool, use_startup: bool, use_service_providing: bool, - project_name: str, project_settings: dict): + def _create_file(file_name: str, content: dict): + if not os.path.isabs(file_name): + file_name = os.path.abspath(file_name) + + path = os.path.dirname(file_name) + if not os.path.isdir(path): + os.makedirs(path) + + with open(file_name, 'w') as project_json: + project_json.write(json.dumps(content, indent=2)) + project_json.close() + + @classmethod + def _create_workspace(cls, path: str, project_name, projects: dict): + ws_dict = { + WorkspaceSettings.__name__: { + WorkspaceSettingsNameEnum.default_project.value: project_name, + WorkspaceSettingsNameEnum.projects.value: projects + } + } + + Console.spinner( + f'Creating {path}', + cls._create_file, + path, + ws_dict, + text_foreground_color=ForegroundColorEnum.green, + spinner_foreground_color=ForegroundColorEnum.cyan + ) + + @classmethod + def build(cls, project_path: str, use_application_api: bool, use_startup: bool, use_service_providing: bool, + project_name: str, project_settings: dict, workspace: Optional[WorkspaceSettings]): """ Builds the console project files :param project_path: @@ -31,40 +67,88 @@ class ConsoleBuilder: :param use_service_providing: :param project_name: :param project_settings: + :param workspace: :return: """ + project_name_snake = String.convert_to_snake_case(project_name) + + if workspace is None: + templates: list[TemplateFileABC] = [ + LicenseTemplate(), + ReadmeTemplate(), + TestsInitTemplate(), + AppsettingsTemplate(), + MainInitTemplate(project_name, os.path.join('src/', project_name_snake)) + ] + else: + project_path = os.path.join( + os.path.dirname(project_path), + project_name_snake + ) + + templates: list[TemplateFileABC] = [ + LicenseTemplate(), + ReadmeTemplate(), + AppsettingsTemplate(), + MainInitTemplate('', '') + ] + if not os.path.isdir(project_path): os.makedirs(project_path) - with open(os.path.join(project_path, 'cpl.json'), 'w') as project_json: - project_json.write(json.dumps(project_settings, indent=2)) - project_json.close() - - templates: list[TemplateFileABC] = [ - LicenseTemplate(), - ReadmeTemplate(), - TestsInitTemplate(), - AppsettingsTemplate(), - MainInitTemplate(project_name) - ] + src_rel_path = '' + src_name = project_name_snake + if workspace is None: + src_rel_path = os.path.join('src/', src_name) if use_application_api: - templates.append(ApplicationTemplate(project_name)) + templates.append(ApplicationTemplate(src_name, src_rel_path)) if use_startup: - templates.append(StartupTemplate(project_name)) - templates.append(MainWithApplicationHostAndStartupTemplate(project_name)) + templates.append(StartupTemplate(src_name, src_rel_path)) + templates.append(MainWithApplicationHostAndStartupTemplate(src_name, src_rel_path)) else: - templates.append(MainWithApplicationBaseTemplate(project_name)) + templates.append(MainWithApplicationBaseTemplate(src_name, src_rel_path)) else: if use_service_providing: - templates.append(MainWithDependencyInjection(project_name)) + templates.append(MainWithDependencyInjection(src_name, src_rel_path)) else: - templates.append(MainWithoutApplicationBaseTemplate(project_name)) + templates.append(MainWithoutApplicationBaseTemplate(src_name, src_rel_path)) + + proj_name = project_name + if workspace is not None: + proj_name = project_name_snake + + project_file_path = f'{project_name_snake}/{project_name}.json' + if workspace is None: + src_path = f'src/{project_name_snake}' + workspace_file_path = f'{proj_name}/cpl-workspace.json' + project_file_rel_path = f'{src_path}/{project_name}.json' + project_file_path = f'{proj_name}/{src_path}/{project_name}.json' + cls._create_workspace(workspace_file_path, project_name, { + project_name: project_file_rel_path + }) + + else: + workspace.projects[project_name] = f'src/{project_file_path}' + cls._create_workspace('cpl-workspace.json', workspace.default_project, workspace.projects) + + Console.spinner( + f'Creating {project_file_path}', + cls._create_file, + project_file_path if workspace is None else f'src/{project_file_path}', + project_settings, + text_foreground_color=ForegroundColorEnum.green, + spinner_foreground_color=ForegroundColorEnum.cyan + ) for template in templates: + divider = '' + if template.path != '' and not template.path.endswith('/'): + divider = '/' + Console.spinner( - f'Creating {project_name}/{template.path}{template.name}', + f'Creating {proj_name}/{template.path}{divider}{template.name}', TemplateBuilder.build, project_path, template, diff --git a/src/cpl_cli/source_creator/library_builder.py b/src/cpl_cli/source_creator/library_builder.py index bc22ccc4..2f410dcb 100644 --- a/src/cpl_cli/source_creator/library_builder.py +++ b/src/cpl_cli/source_creator/library_builder.py @@ -1,18 +1,23 @@ import json import os +from typing import Optional + from cpl.console.foreground_color_enum import ForegroundColorEnum from cpl.console.console import Console +from cpl.utils.string import String +from cpl_cli.configuration.workspace_settings import WorkspaceSettings +from cpl_cli.configuration.workspace_settings_name_enum import WorkspaceSettingsNameEnum from cpl_cli.source_creator.template_builder import TemplateBuilder -from cpl_cli.templates.new.library.appsettings_json import AppsettingsTemplate -from cpl_cli.templates.new.library.license import LicenseTemplate -from cpl_cli.templates.new.library.readme_py import ReadmeTemplate -from cpl_cli.templates.new.library.src.cli.application import ApplicationTemplate -from cpl_cli.templates.new.library.src.cli.init import CLIInitTemplate -from cpl_cli.templates.new.library.src.cli.main import MainWithApplicationHostAndStartupTemplate, \ +from cpl_cli._templates.new.library.appsettings_json import AppsettingsTemplate +from cpl_cli._templates.new.library.license import LicenseTemplate +from cpl_cli._templates.new.library.readme_py import ReadmeTemplate +from cpl_cli._templates.new.library.source.name.application import ApplicationTemplate +from cpl_cli._templates.new.library.source.name.init import NameInitTemplate +from cpl_cli._templates.new.library.source.name.main import MainWithApplicationHostAndStartupTemplate, \ MainWithoutApplicationBaseTemplate, MainWithApplicationBaseTemplate, MainWithDependencyInjection -from cpl_cli.templates.new.library.src.cli.startup import StartupTemplate -from cpl_cli.templates.new.library.src.tests.init import TestsInitTemplate -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.new.library.source.name.startup import StartupTemplate +from cpl_cli._templates.new.library.source.tests.init import TestsInitTemplate +from cpl_cli._templates.template_file_abc import TemplateFileABC class LibraryBuilder: @@ -21,8 +26,40 @@ class LibraryBuilder: pass @staticmethod - def build(project_path: str, use_application_api: bool, use_startup: bool, use_service_providing: bool, - project_name: str, project_settings: dict): + def _create_file(file_name: str, content: dict): + if not os.path.isabs(file_name): + file_name = os.path.abspath(file_name) + + path = os.path.dirname(file_name) + if not os.path.isdir(path): + os.makedirs(path) + + with open(file_name, 'w') as project_json: + project_json.write(json.dumps(content, indent=2)) + project_json.close() + + @classmethod + def _create_workspace(cls, path: str, project_name, projects: dict): + ws_dict = { + WorkspaceSettings.__name__: { + WorkspaceSettingsNameEnum.default_project.value: project_name, + WorkspaceSettingsNameEnum.projects.value: projects + } + } + + Console.spinner( + f'Creating {path}', + cls._create_file, + path, + ws_dict, + text_foreground_color=ForegroundColorEnum.green, + spinner_foreground_color=ForegroundColorEnum.cyan + ) + + @classmethod + def build(cls, project_path: str, use_application_api: bool, use_startup: bool, + use_service_providing: bool, project_name: str, project_settings: dict, + workspace: Optional[WorkspaceSettings]): """ Builds the library project files :param project_path: @@ -31,40 +68,88 @@ class LibraryBuilder: :param use_service_providing: :param project_name: :param project_settings: + :param workspace: :return: """ + project_name_snake = String.convert_to_snake_case(project_name) + + if workspace is None: + templates: list[TemplateFileABC] = [ + LicenseTemplate(), + ReadmeTemplate(), + TestsInitTemplate(), + NameInitTemplate(project_name, os.path.join('src/', project_name_snake)), + AppsettingsTemplate() + ] + else: + project_path = os.path.join( + os.path.dirname(project_path), + project_name_snake + ) + + templates: list[TemplateFileABC] = [ + LicenseTemplate(), + ReadmeTemplate(), + NameInitTemplate('', ''), + AppsettingsTemplate() + ] + if not os.path.isdir(project_path): os.makedirs(project_path) - with open(os.path.join(project_path, 'cpl.json'), 'w') as project_json: - project_json.write(json.dumps(project_settings, indent=2)) - project_json.close() - - templates: list[TemplateFileABC] = [ - LicenseTemplate(), - ReadmeTemplate(), - TestsInitTemplate(), - CLIInitTemplate(project_name), - AppsettingsTemplate() - ] + src_rel_path = '' + src_name = project_name_snake + if workspace is None: + src_rel_path = os.path.join('src/', src_name) if use_application_api: - templates.append(ApplicationTemplate(project_name)) + templates.append(ApplicationTemplate(src_name, src_rel_path)) if use_startup: - templates.append(StartupTemplate(project_name)) - templates.append(MainWithApplicationHostAndStartupTemplate(project_name)) + templates.append(StartupTemplate(src_name, src_rel_path)) + templates.append(MainWithApplicationHostAndStartupTemplate(src_name, src_rel_path)) else: - templates.append(MainWithApplicationBaseTemplate()) + templates.append(MainWithApplicationBaseTemplate(src_name, src_rel_path)) else: if use_service_providing: - templates.append(MainWithDependencyInjection()) + templates.append(MainWithDependencyInjection(src_name, src_rel_path)) else: - templates.append(MainWithoutApplicationBaseTemplate()) + templates.append(MainWithoutApplicationBaseTemplate(src_name, src_rel_path)) + + proj_name = project_name + if workspace is not None: + proj_name = project_name_snake + + project_file_path = f'{project_name_snake}/{project_name}.json' + if workspace is None: + src_path = f'src/{project_name_snake}' + workspace_file_path = f'{proj_name}/cpl-workspace.json' + project_file_rel_path = f'{src_path}/{project_name}.json' + project_file_path = f'{proj_name}/{src_path}/{project_name}.json' + cls._create_workspace(workspace_file_path, project_name, { + project_name: project_file_rel_path + }) + + else: + workspace.projects[project_name] = f'src/{project_file_path}' + cls._create_workspace('cpl-workspace.json', workspace.default_project, workspace.projects) + + Console.spinner( + f'Creating {project_file_path}', + cls._create_file, + project_file_path if workspace is None else f'src/{project_file_path}', + project_settings, + text_foreground_color=ForegroundColorEnum.green, + spinner_foreground_color=ForegroundColorEnum.cyan + ) for template in templates: + divider = '' + if template.path != '' and not template.path.endswith('/'): + divider = '/' + Console.spinner( - f'Creating {project_name}/{template.path}{template.name}', + f'Creating {proj_name}/{template.path}{divider}{template.name}', TemplateBuilder.build, project_path, template, diff --git a/src/cpl_cli/source_creator/template_builder.py b/src/cpl_cli/source_creator/template_builder.py index 1ccfbce0..20939a64 100644 --- a/src/cpl_cli/source_creator/template_builder.py +++ b/src/cpl_cli/source_creator/template_builder.py @@ -1,6 +1,6 @@ import os -from cpl_cli.templates.template_file_abc import TemplateFileABC +from cpl_cli._templates.template_file_abc import TemplateFileABC class TemplateBuilder: @@ -19,6 +19,6 @@ class TemplateBuilder: if not os.path.isdir(file_rel_path): os.makedirs(file_rel_path) - with open(file_path, 'w') as license_file: - license_file.write(template.value) - license_file.close() + with open(file_path, 'w') as file: + file.write(template.value) + file.close() diff --git a/src/cpl_cli/startup.py b/src/cpl_cli/startup.py index f05fe10a..3e0cf9c9 100644 --- a/src/cpl_cli/startup.py +++ b/src/cpl_cli/startup.py @@ -1,13 +1,17 @@ +import os + from cpl.application.startup_abc import StartupABC from cpl.configuration.console_argument import ConsoleArgument from cpl.configuration.configuration_abc import ConfigurationABC from cpl.dependency_injection.service_collection_abc import ServiceCollectionABC from cpl.dependency_injection.service_provider_abc import ServiceProviderABC +from cpl_cli.command.add_service import AddService from cpl_cli.command.build_service import BuildService from cpl_cli.command.generate_service import GenerateService from cpl_cli.command.install_service import InstallService from cpl_cli.command.new_service import NewService from cpl_cli.command.publish_service import PublishService +from cpl_cli.command.remove_service import RemoveService from cpl_cli.command.start_service import StartService from cpl_cli.command.uninstall_service import UninstallService from cpl_cli.command.update_service import UpdateService @@ -29,7 +33,7 @@ class Startup(StartupABC): self._env = self._configuration.environment self._services = services - self._env.set_runtime_directory(__file__) + self._env.set_runtime_directory(os.path.dirname(__file__)) def configure_configuration(self) -> ConfigurationABC: self._configuration.argument_error_function = Error.error @@ -38,6 +42,8 @@ class Startup(StartupABC): self._configuration.add_environment_variables('CPL_') self._configuration.add_json_file('appsettings.json', path=self._env.runtime_directory, optional=False, output=False) + + self._configuration.add_console_argument(ConsoleArgument('', 'add', ['a', 'a'], ' ')) self._configuration.add_console_argument(ConsoleArgument('', 'build', ['b', 'B'], '')) self._configuration.add_console_argument(ConsoleArgument('', 'generate', ['g', 'G'], '', console_arguments=[ ConsoleArgument('', 'abc', ['a', 'A'], ' '), @@ -47,7 +53,9 @@ class Startup(StartupABC): ConsoleArgument('', 'settings', ['st', 'ST'], ' '), ConsoleArgument('', 'thread', ['t', 't'], ' ') ])) - self._configuration.add_console_argument(ConsoleArgument('', 'help', ['h', 'H'], '')) + self._configuration.add_console_argument( + ConsoleArgument('', 'help', ['h', 'H'], ' ', is_value_token_optional=True) + ) self._configuration.add_console_argument( ConsoleArgument('', 'install', ['i', 'I'], ' ', is_value_token_optional=True) ) @@ -56,10 +64,14 @@ class Startup(StartupABC): ConsoleArgument('', 'library', ['l', 'L'], ' ') ])) self._configuration.add_console_argument(ConsoleArgument('', 'publish', ['p', 'P'], '')) + self._configuration.add_console_argument(ConsoleArgument('', 'remove', ['r', 'R'], ' ')) self._configuration.add_console_argument(ConsoleArgument('', 'start', ['s', 'S'], '')) self._configuration.add_console_argument(ConsoleArgument('', 'uninstall', ['ui', 'UI'], ' ')) self._configuration.add_console_argument(ConsoleArgument('', 'update', ['u', 'U'], '')) self._configuration.add_console_argument(ConsoleArgument('', 'version', ['v', 'V'], '')) + + self._configuration.add_console_argument(ConsoleArgument('', '--help', ['-h', '-H'], '')) + self._configuration.add_console_arguments(error=False) return self._configuration @@ -70,12 +82,14 @@ class Startup(StartupABC): self._services.add_transient(PublisherABC, PublisherService) self._services.add_transient(LiveServerService) + self._services.add_transient(AddService) self._services.add_transient(BuildService) self._services.add_transient(GenerateService) self._services.add_transient(HelpService) self._services.add_transient(InstallService) self._services.add_transient(NewService) self._services.add_transient(PublishService) + self._services.add_transient(RemoveService) self._services.add_transient(StartService) self._services.add_transient(UninstallService) self._services.add_transient(UpdateService) diff --git a/src/cpl_cli/templates/new/console/__init__.py b/src/cpl_cli/templates/new/console/__init__.py deleted file mode 100644 index b1a8e76d..00000000 --- a/src/cpl_cli/templates/new/console/__init__.py +++ /dev/null @@ -1,25 +0,0 @@ -# -*- coding: utf-8 -*- - -""" -sh_cpl sh-edraft Common Python library -~~~~~~~~~~~~~~~~~~~ - -sh-edraft Common Python library - -:copyright: (c) 2020 - 2021 sh-edraft.de -:license: MIT, see LICENSE for more details. - -""" - -__title__ = 'cpl_cli.templates.new.console' -__author__ = 'Sven Heidemann' -__license__ = 'MIT' -__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' - -from collections import namedtuple - -# imports: - -VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') diff --git a/src/cpl_cli/templates/new/console/src/__init__.py b/src/cpl_cli/templates/new/console/src/__init__.py deleted file mode 100644 index b666bf0d..00000000 --- a/src/cpl_cli/templates/new/console/src/__init__.py +++ /dev/null @@ -1,25 +0,0 @@ -# -*- coding: utf-8 -*- - -""" -sh_cpl sh-edraft Common Python library -~~~~~~~~~~~~~~~~~~~ - -sh-edraft Common Python library - -:copyright: (c) 2020 - 2021 sh-edraft.de -:license: MIT, see LICENSE for more details. - -""" - -__title__ = 'cpl_cli.templates.new.console.src' -__author__ = 'Sven Heidemann' -__license__ = 'MIT' -__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' - -from collections import namedtuple - -# imports: - -VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') diff --git a/src/cpl_cli/templates/new/console/src/name/__init__.py b/src/cpl_cli/templates/new/console/src/name/__init__.py deleted file mode 100644 index 6f728248..00000000 --- a/src/cpl_cli/templates/new/console/src/name/__init__.py +++ /dev/null @@ -1,25 +0,0 @@ -# -*- coding: utf-8 -*- - -""" -sh_cpl sh-edraft Common Python library -~~~~~~~~~~~~~~~~~~~ - -sh-edraft Common Python library - -:copyright: (c) 2020 - 2021 sh-edraft.de -:license: MIT, see LICENSE for more details. - -""" - -__title__ = 'cpl_cli.templates.new.console.src.name' -__author__ = 'Sven Heidemann' -__license__ = 'MIT' -__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' - -from collections import namedtuple - -# imports: - -VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') diff --git a/src/cpl_cli/templates/new/console/src/tests/__init__.py b/src/cpl_cli/templates/new/console/src/tests/__init__.py deleted file mode 100644 index 365d5174..00000000 --- a/src/cpl_cli/templates/new/console/src/tests/__init__.py +++ /dev/null @@ -1,25 +0,0 @@ -# -*- coding: utf-8 -*- - -""" -sh_cpl sh-edraft Common Python library -~~~~~~~~~~~~~~~~~~~ - -sh-edraft Common Python library - -:copyright: (c) 2020 - 2021 sh-edraft.de -:license: MIT, see LICENSE for more details. - -""" - -__title__ = 'cpl_cli.templates.new.console.src.tests' -__author__ = 'Sven Heidemann' -__license__ = 'MIT' -__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' - -from collections import namedtuple - -# imports: - -VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') diff --git a/src/cpl_cli/templates/new/library/__init__.py b/src/cpl_cli/templates/new/library/__init__.py deleted file mode 100644 index 43584a93..00000000 --- a/src/cpl_cli/templates/new/library/__init__.py +++ /dev/null @@ -1,25 +0,0 @@ -# -*- coding: utf-8 -*- - -""" -sh_cpl sh-edraft Common Python library -~~~~~~~~~~~~~~~~~~~ - -sh-edraft Common Python library - -:copyright: (c) 2020 - 2021 sh-edraft.de -:license: MIT, see LICENSE for more details. - -""" - -__title__ = 'cpl_cli.templates.new.library' -__author__ = 'Sven Heidemann' -__license__ = 'MIT' -__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' - -from collections import namedtuple - -# imports: - -VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') diff --git a/src/cpl_cli/templates/new/library/src/__init__.py b/src/cpl_cli/templates/new/library/src/__init__.py deleted file mode 100644 index d21498c7..00000000 --- a/src/cpl_cli/templates/new/library/src/__init__.py +++ /dev/null @@ -1,25 +0,0 @@ -# -*- coding: utf-8 -*- - -""" -sh_cpl sh-edraft Common Python library -~~~~~~~~~~~~~~~~~~~ - -sh-edraft Common Python library - -:copyright: (c) 2020 - 2021 sh-edraft.de -:license: MIT, see LICENSE for more details. - -""" - -__title__ = 'cpl_cli.templates.new.library.src' -__author__ = 'Sven Heidemann' -__license__ = 'MIT' -__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' - -from collections import namedtuple - -# imports: - -VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') diff --git a/src/cpl_cli/templates/new/library/src/cli/__init__.py b/src/cpl_cli/templates/new/library/src/cli/__init__.py deleted file mode 100644 index 5f59f690..00000000 --- a/src/cpl_cli/templates/new/library/src/cli/__init__.py +++ /dev/null @@ -1,25 +0,0 @@ -# -*- coding: utf-8 -*- - -""" -sh_cpl sh-edraft Common Python library -~~~~~~~~~~~~~~~~~~~ - -sh-edraft Common Python library - -:copyright: (c) 2020 - 2021 sh-edraft.de -:license: MIT, see LICENSE for more details. - -""" - -__title__ = 'cpl_cli.templates.new.library.src.cli' -__author__ = 'Sven Heidemann' -__license__ = 'MIT' -__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' - -from collections import namedtuple - -# imports: - -VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') diff --git a/src/cpl_cli/templates/new/library/src/cli/init.py b/src/cpl_cli/templates/new/library/src/cli/init.py deleted file mode 100644 index 28634bf3..00000000 --- a/src/cpl_cli/templates/new/library/src/cli/init.py +++ /dev/null @@ -1,29 +0,0 @@ -import textwrap - -from cpl.utils.string import String -from cpl_cli.templates.template_file_abc import TemplateFileABC - - -class CLIInitTemplate(TemplateFileABC): - - def __init__(self, name: str): - TemplateFileABC.__init__(self) - - name = String.convert_to_snake_case(name) - self._name = '__init__.py' - self._path = f'src/{name}_cli/' - self._value = textwrap.dedent("""\ - # imports: - """) - - @property - def name(self) -> str: - return self._name - - @property - def path(self) -> str: - return self._path - - @property - def value(self) -> str: - return self._value diff --git a/src/cpl_cli/templates/new/library/src/name/__init__.py b/src/cpl_cli/templates/new/library/src/name/__init__.py deleted file mode 100644 index 2421f687..00000000 --- a/src/cpl_cli/templates/new/library/src/name/__init__.py +++ /dev/null @@ -1,25 +0,0 @@ -# -*- coding: utf-8 -*- - -""" -sh_cpl sh-edraft Common Python library -~~~~~~~~~~~~~~~~~~~ - -sh-edraft Common Python library - -:copyright: (c) 2020 - 2021 sh-edraft.de -:license: MIT, see LICENSE for more details. - -""" - -__title__ = 'cpl_cli.templates.new.library.src.name' -__author__ = 'Sven Heidemann' -__license__ = 'MIT' -__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' - -from collections import namedtuple - -# imports: - -VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') diff --git a/src/cpl_cli/templates/new/library/src/tests/__init__.py b/src/cpl_cli/templates/new/library/src/tests/__init__.py deleted file mode 100644 index 33fba570..00000000 --- a/src/cpl_cli/templates/new/library/src/tests/__init__.py +++ /dev/null @@ -1,25 +0,0 @@ -# -*- coding: utf-8 -*- - -""" -sh_cpl sh-edraft Common Python library -~~~~~~~~~~~~~~~~~~~ - -sh-edraft Common Python library - -:copyright: (c) 2020 - 2021 sh-edraft.de -:license: MIT, see LICENSE for more details. - -""" - -__title__ = 'cpl_cli.templates.new.library.src.tests' -__author__ = 'Sven Heidemann' -__license__ = 'MIT' -__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' - -from collections import namedtuple - -# imports: - -VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') diff --git a/src/cpl_cli/templates/publish/__init__.py b/src/cpl_cli/templates/publish/__init__.py deleted file mode 100644 index 1c84a56d..00000000 --- a/src/cpl_cli/templates/publish/__init__.py +++ /dev/null @@ -1,25 +0,0 @@ -# -*- coding: utf-8 -*- - -""" -sh_cpl sh-edraft Common Python library -~~~~~~~~~~~~~~~~~~~ - -sh-edraft Common Python library - -:copyright: (c) 2020 - 2021 sh-edraft.de -:license: MIT, see LICENSE for more details. - -""" - -__title__ = 'cpl_cli.templates.publish' -__author__ = 'Sven Heidemann' -__license__ = 'MIT' -__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' -__version__ = '2021.4.0' - -from collections import namedtuple - -# imports: - -VersionInfo = namedtuple('VersionInfo', 'major minor micro') -version_info = VersionInfo(major='2021', minor='04', micro='0') diff --git a/src/tests/custom/console/__init__.py b/src/tests/custom/console/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/src/tests/custom/general/__init__.py b/src/tests/custom/general/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/src/tests/custom/general/cpl-workspace.json b/src/tests/custom/general/cpl-workspace.json new file mode 100644 index 00000000..3b5ae16f --- /dev/null +++ b/src/tests/custom/general/cpl-workspace.json @@ -0,0 +1,8 @@ +{ + "Workspace": { + "DefaultProject": "general", + "Projects": { + "general": "src/general/general.json" + } + } +} \ No newline at end of file diff --git a/src/tests/custom/general/main.py b/src/tests/custom/general/main.py deleted file mode 100644 index a9fd514f..00000000 --- a/src/tests/custom/general/main.py +++ /dev/null @@ -1,13 +0,0 @@ -from cpl.application.application_builder import ApplicationBuilder -from tests.custom.general.application import Application -from tests.custom.general.startup import Startup - - -def main(): - app_builder = ApplicationBuilder(Application) - app_builder.use_startup(Startup) - app_builder.build().run() - - -if __name__ == '__main__': - main() diff --git a/src/tests/custom/__init__.py b/src/tests/custom/general/src/general/__init__.py similarity index 100% rename from src/tests/custom/__init__.py rename to src/tests/custom/general/src/general/__init__.py diff --git a/src/tests/custom/general/application.py b/src/tests/custom/general/src/general/application.py similarity index 97% rename from src/tests/custom/general/application.py rename to src/tests/custom/general/src/general/application.py index f7af31b0..96bcb086 100644 --- a/src/tests/custom/general/application.py +++ b/src/tests/custom/general/src/general/application.py @@ -8,7 +8,7 @@ from cpl.dependency_injection.service_provider_abc import ServiceProviderABC from cpl.logging.logger_abc import LoggerABC from cpl.mailing.email import EMail from cpl.mailing.email_client_abc import EMailClientABC -from tests.custom.general.test_service import TestService +from test_service import TestService class Application(ApplicationABC): diff --git a/src/tests/custom/general/appsettings.development.json b/src/tests/custom/general/src/general/appsettings.development.json similarity index 100% rename from src/tests/custom/general/appsettings.development.json rename to src/tests/custom/general/src/general/appsettings.development.json diff --git a/src/tests/custom/general/appsettings.edrafts-lapi.json b/src/tests/custom/general/src/general/appsettings.edrafts-lapi.json similarity index 100% rename from src/tests/custom/general/appsettings.edrafts-lapi.json rename to src/tests/custom/general/src/general/appsettings.edrafts-lapi.json diff --git a/src/tests/custom/general/appsettings.edrafts-pc.json b/src/tests/custom/general/src/general/appsettings.edrafts-pc.json similarity index 100% rename from src/tests/custom/general/appsettings.edrafts-pc.json rename to src/tests/custom/general/src/general/appsettings.edrafts-pc.json diff --git a/src/tests/custom/general/appsettings.json b/src/tests/custom/general/src/general/appsettings.json similarity index 100% rename from src/tests/custom/general/appsettings.json rename to src/tests/custom/general/src/general/appsettings.json diff --git a/src/tests/custom/general/db/__init__.py b/src/tests/custom/general/src/general/db/__init__.py similarity index 100% rename from src/tests/custom/general/db/__init__.py rename to src/tests/custom/general/src/general/db/__init__.py diff --git a/src/tests/custom/general/cpl.json b/src/tests/custom/general/src/general/general.json similarity index 85% rename from src/tests/custom/general/cpl.json rename to src/tests/custom/general/src/general/general.json index b57adb29..8c2aee2a 100644 --- a/src/tests/custom/general/cpl.json +++ b/src/tests/custom/general/src/general/general.json @@ -1,6 +1,6 @@ { "ProjectSettings": { - "Name": "sh_cpl.tests", + "Name": "general", "Version": { "Major": "2021", "Minor": "04", @@ -16,12 +16,11 @@ "LicenseName": "MIT", "LicenseDescription": "MIT, see LICENSE for more details.", "Dependencies": [ - "sh_cpl==2021.4.1.post13", - "discord.py==1.6.0" + "sh_cpl==2021.4.dev1" ], "PythonVersion": ">=3.8", "PythonPath": { - "linux": "../../../../cpl-env/bin/python3.9", + "linux": "../../../../../../cpl-env/bin/python3.9", "win32": "" }, "Classifiers": [] @@ -31,7 +30,7 @@ "SourcePath": "", "OutputPath": "dist", "Main": "main", - "EntryPoint": "cpl", + "EntryPoint": "", "IncludePackageData": true, "Included": [ "*/templates" diff --git a/src/tests/generated/startup-app/src/main.py b/src/tests/custom/general/src/general/main.py similarity index 77% rename from src/tests/generated/startup-app/src/main.py rename to src/tests/custom/general/src/general/main.py index 6e678925..a2e8cbd0 100644 --- a/src/tests/generated/startup-app/src/main.py +++ b/src/tests/custom/general/src/general/main.py @@ -1,5 +1,4 @@ -from cpl.application import ApplicationBuilder - +from cpl.application.application_builder import ApplicationBuilder from application import Application from startup import Startup diff --git a/src/tests/custom/general/startup.py b/src/tests/custom/general/src/general/startup.py similarity index 93% rename from src/tests/custom/general/startup.py rename to src/tests/custom/general/src/general/startup.py index d0370bff..102ae67b 100644 --- a/src/tests/custom/general/startup.py +++ b/src/tests/custom/general/src/general/startup.py @@ -6,7 +6,7 @@ from cpl.logging.logger_service import Logger from cpl.logging.logger_abc import LoggerABC from cpl.mailing.email_client_service import EMailClient from cpl.mailing.email_client_abc import EMailClientABC -from tests.custom.general.test_service import TestService +from test_service import TestService class Startup(StartupABC): @@ -20,7 +20,6 @@ class Startup(StartupABC): def configure_configuration(self) -> ConfigurationABC: self._configuration.add_environment_variables('PYTHON_') self._configuration.add_environment_variables('CPL_') - self._configuration.add_console_arguments() self._configuration.add_json_file(f'appsettings.json') self._configuration.add_json_file(f'appsettings.{self._configuration.environment.environment_name}.json') self._configuration.add_json_file(f'appsettings.{self._configuration.environment.host_name}.json', optional=True) diff --git a/src/tests/custom/general/test_service.py b/src/tests/custom/general/src/general/test_service.py similarity index 100% rename from src/tests/custom/general/test_service.py rename to src/tests/custom/general/src/general/test_service.py diff --git a/src/tests/generated/simple-app/appsettings.json b/src/tests/generated/simple-app/appsettings.json new file mode 100644 index 00000000..629e6ebd --- /dev/null +++ b/src/tests/generated/simple-app/appsettings.json @@ -0,0 +1,15 @@ +{ + "TimeFormatSettings": { + "DateFormat": "%Y-%m-%d", + "TimeFormat": "%H:%M:%S", + "DateTimeFormat": "%Y-%m-%d %H:%M:%S.%f", + "DateTimeLogFormat": "%Y-%m-%d_%H-%M-%S" + }, + + "LoggingSettings": { + "Path": "logs/", + "Filename": "log_$start_time.log", + "ConsoleLogLevel": "ERROR", + "FileLogLevel": "WARN" + } +} diff --git a/src/tests/generated/simple-app/cpl-workspace.json b/src/tests/generated/simple-app/cpl-workspace.json new file mode 100644 index 00000000..0ed056c2 --- /dev/null +++ b/src/tests/generated/simple-app/cpl-workspace.json @@ -0,0 +1,8 @@ +{ + "WorkspaceSettings": { + "DefaultProject": "simple-app", + "Projects": { + "simple-app": "src/simple_app/simple-app.json" + } + } +} \ No newline at end of file diff --git a/src/tests/generated/startup-app/src/tests/__init__.py b/src/tests/generated/simple-app/src/simple_app/__init__.py similarity index 100% rename from src/tests/generated/startup-app/src/tests/__init__.py rename to src/tests/generated/simple-app/src/simple_app/__init__.py diff --git a/src/tests/generated/simple-app/src/application.py b/src/tests/generated/simple-app/src/simple_app/application.py similarity index 100% rename from src/tests/generated/simple-app/src/application.py rename to src/tests/generated/simple-app/src/simple_app/application.py diff --git a/src/tests/generated/simple-app/src/main.py b/src/tests/generated/simple-app/src/simple_app/main.py similarity index 79% rename from src/tests/generated/simple-app/src/main.py rename to src/tests/generated/simple-app/src/simple_app/main.py index 3d3e7eba..c5d29314 100644 --- a/src/tests/generated/simple-app/src/main.py +++ b/src/tests/generated/simple-app/src/simple_app/main.py @@ -1,6 +1,6 @@ from cpl.application import ApplicationBuilder -from application import Application +from simple_app.application import Application def main(): diff --git a/src/tests/generated/simple-app/cpl.json b/src/tests/generated/simple-app/src/simple_app/simple-app.json similarity index 80% rename from src/tests/generated/simple-app/cpl.json rename to src/tests/generated/simple-app/src/simple_app/simple-app.json index f223da45..5375d662 100644 --- a/src/tests/generated/simple-app/cpl.json +++ b/src/tests/generated/simple-app/src/simple_app/simple-app.json @@ -16,7 +16,7 @@ "LicenseName": "", "LicenseDescription": "", "Dependencies": [ - "sh_cpl==2021.4.2" + "sh_cpl==2021.4.1rc2" ], "PythonVersion": ">=3.9.2", "PythonPath": { @@ -26,9 +26,9 @@ }, "BuildSettings": { "ProjectType": "console", - "SourcePath": "src", - "OutputPath": "dist", - "Main": "main", + "SourcePath": "", + "OutputPath": "../../dist", + "Main": "simple_app.main", "EntryPoint": "simple-app", "IncludePackageData": false, "Included": [], @@ -37,6 +37,7 @@ "*/logs", "*/tests" ], - "PackageData": {} + "PackageData": {}, + "ProjectReferences": [] } } \ No newline at end of file diff --git a/src/tests/generated/simple-console/appsettings.json b/src/tests/generated/simple-console/appsettings.json new file mode 100644 index 00000000..629e6ebd --- /dev/null +++ b/src/tests/generated/simple-console/appsettings.json @@ -0,0 +1,15 @@ +{ + "TimeFormatSettings": { + "DateFormat": "%Y-%m-%d", + "TimeFormat": "%H:%M:%S", + "DateTimeFormat": "%Y-%m-%d %H:%M:%S.%f", + "DateTimeLogFormat": "%Y-%m-%d_%H-%M-%S" + }, + + "LoggingSettings": { + "Path": "logs/", + "Filename": "log_$start_time.log", + "ConsoleLogLevel": "ERROR", + "FileLogLevel": "WARN" + } +} diff --git a/src/tests/generated/simple-console/cpl-workspace.json b/src/tests/generated/simple-console/cpl-workspace.json new file mode 100644 index 00000000..449bc77d --- /dev/null +++ b/src/tests/generated/simple-console/cpl-workspace.json @@ -0,0 +1,8 @@ +{ + "WorkspaceSettings": { + "DefaultProject": "simple-console", + "Projects": { + "simple-console": "src/simple_console/simple-console.json" + } + } +} \ No newline at end of file diff --git a/src/tests/generated/simple-console/src/simple_console/__init__.py b/src/tests/generated/simple-console/src/simple_console/__init__.py new file mode 100644 index 00000000..ad5eca30 --- /dev/null +++ b/src/tests/generated/simple-console/src/simple_console/__init__.py @@ -0,0 +1 @@ +# imports: diff --git a/src/tests/generated/simple-console/src/main.py b/src/tests/generated/simple-console/src/simple_console/main.py similarity index 100% rename from src/tests/generated/simple-console/src/main.py rename to src/tests/generated/simple-console/src/simple_console/main.py diff --git a/src/tests/generated/simple-console/cpl.json b/src/tests/generated/simple-console/src/simple_console/simple-console.json similarity index 80% rename from src/tests/generated/simple-console/cpl.json rename to src/tests/generated/simple-console/src/simple_console/simple-console.json index 63fe1a4d..e05e9201 100644 --- a/src/tests/generated/simple-console/cpl.json +++ b/src/tests/generated/simple-console/src/simple_console/simple-console.json @@ -16,7 +16,7 @@ "LicenseName": "", "LicenseDescription": "", "Dependencies": [ - "sh_cpl==2021.4.2" + "sh_cpl==2021.4.1rc2" ], "PythonVersion": ">=3.9.2", "PythonPath": { @@ -26,9 +26,9 @@ }, "BuildSettings": { "ProjectType": "console", - "SourcePath": "src", - "OutputPath": "dist", - "Main": "main", + "SourcePath": "", + "OutputPath": "../../dist", + "Main": "simple_console.main", "EntryPoint": "simple-console", "IncludePackageData": false, "Included": [], @@ -37,6 +37,7 @@ "*/logs", "*/tests" ], - "PackageData": {} + "PackageData": {}, + "ProjectReferences": [] } } \ No newline at end of file diff --git a/src/tests/generated/simple-di/appsettings.json b/src/tests/generated/simple-di/appsettings.json new file mode 100644 index 00000000..629e6ebd --- /dev/null +++ b/src/tests/generated/simple-di/appsettings.json @@ -0,0 +1,15 @@ +{ + "TimeFormatSettings": { + "DateFormat": "%Y-%m-%d", + "TimeFormat": "%H:%M:%S", + "DateTimeFormat": "%Y-%m-%d %H:%M:%S.%f", + "DateTimeLogFormat": "%Y-%m-%d_%H-%M-%S" + }, + + "LoggingSettings": { + "Path": "logs/", + "Filename": "log_$start_time.log", + "ConsoleLogLevel": "ERROR", + "FileLogLevel": "WARN" + } +} diff --git a/src/tests/generated/simple-di/cpl-workspace.json b/src/tests/generated/simple-di/cpl-workspace.json new file mode 100644 index 00000000..269f9340 --- /dev/null +++ b/src/tests/generated/simple-di/cpl-workspace.json @@ -0,0 +1,8 @@ +{ + "WorkspaceSettings": { + "DefaultProject": "simple-di", + "Projects": { + "simple-di": "src/simple_di/simple-di.json" + } + } +} \ No newline at end of file diff --git a/src/tests/generated/simple-di/src/simple_di/__init__.py b/src/tests/generated/simple-di/src/simple_di/__init__.py new file mode 100644 index 00000000..ad5eca30 --- /dev/null +++ b/src/tests/generated/simple-di/src/simple_di/__init__.py @@ -0,0 +1 @@ +# imports: diff --git a/src/tests/generated/simple-di/src/main.py b/src/tests/generated/simple-di/src/simple_di/main.py similarity index 100% rename from src/tests/generated/simple-di/src/main.py rename to src/tests/generated/simple-di/src/simple_di/main.py diff --git a/src/tests/generated/simple-di/cpl.json b/src/tests/generated/simple-di/src/simple_di/simple-di.json similarity index 81% rename from src/tests/generated/simple-di/cpl.json rename to src/tests/generated/simple-di/src/simple_di/simple-di.json index 8804958a..b5591ebf 100644 --- a/src/tests/generated/simple-di/cpl.json +++ b/src/tests/generated/simple-di/src/simple_di/simple-di.json @@ -16,7 +16,7 @@ "LicenseName": "", "LicenseDescription": "", "Dependencies": [ - "sh_cpl==2021.4.2.dev1" + "sh_cpl==2021.4.1rc2" ], "PythonVersion": ">=3.9.2", "PythonPath": { @@ -26,9 +26,9 @@ }, "BuildSettings": { "ProjectType": "console", - "SourcePath": "src", - "OutputPath": "dist", - "Main": "main", + "SourcePath": "", + "OutputPath": "../../dist", + "Main": "simple_di.main", "EntryPoint": "simple-di", "IncludePackageData": false, "Included": [], @@ -37,6 +37,7 @@ "*/logs", "*/tests" ], - "PackageData": {} + "PackageData": {}, + "ProjectReferences": [] } } \ No newline at end of file diff --git a/src/tests/generated/startup-app/LICENSE b/src/tests/generated/simple-startup-app/LICENSE similarity index 100% rename from src/tests/generated/startup-app/LICENSE rename to src/tests/generated/simple-startup-app/LICENSE diff --git a/src/tests/generated/startup-app/README.md b/src/tests/generated/simple-startup-app/README.md similarity index 100% rename from src/tests/generated/startup-app/README.md rename to src/tests/generated/simple-startup-app/README.md diff --git a/src/tests/generated/simple-startup-app/appsettings.json b/src/tests/generated/simple-startup-app/appsettings.json new file mode 100644 index 00000000..629e6ebd --- /dev/null +++ b/src/tests/generated/simple-startup-app/appsettings.json @@ -0,0 +1,15 @@ +{ + "TimeFormatSettings": { + "DateFormat": "%Y-%m-%d", + "TimeFormat": "%H:%M:%S", + "DateTimeFormat": "%Y-%m-%d %H:%M:%S.%f", + "DateTimeLogFormat": "%Y-%m-%d_%H-%M-%S" + }, + + "LoggingSettings": { + "Path": "logs/", + "Filename": "log_$start_time.log", + "ConsoleLogLevel": "ERROR", + "FileLogLevel": "WARN" + } +} diff --git a/src/tests/generated/simple-startup-app/cpl-workspace.json b/src/tests/generated/simple-startup-app/cpl-workspace.json new file mode 100644 index 00000000..9fe5c55c --- /dev/null +++ b/src/tests/generated/simple-startup-app/cpl-workspace.json @@ -0,0 +1,8 @@ +{ + "WorkspaceSettings": { + "DefaultProject": "simple-startup-app", + "Projects": { + "simple-startup-app": "src/simple_startup_app/simple-startup-app.json" + } + } +} \ No newline at end of file diff --git a/src/tests/generated/simple-startup-app/src/simple_startup_app/__init__.py b/src/tests/generated/simple-startup-app/src/simple_startup_app/__init__.py new file mode 100644 index 00000000..ad5eca30 --- /dev/null +++ b/src/tests/generated/simple-startup-app/src/simple_startup_app/__init__.py @@ -0,0 +1 @@ +# imports: diff --git a/src/tests/generated/startup-app/src/application.py b/src/tests/generated/simple-startup-app/src/simple_startup_app/application.py similarity index 100% rename from src/tests/generated/startup-app/src/application.py rename to src/tests/generated/simple-startup-app/src/simple_startup_app/application.py diff --git a/src/tests/generated/simple-startup-app/src/simple_startup_app/main.py b/src/tests/generated/simple-startup-app/src/simple_startup_app/main.py new file mode 100644 index 00000000..4bbb4aed --- /dev/null +++ b/src/tests/generated/simple-startup-app/src/simple_startup_app/main.py @@ -0,0 +1,14 @@ +from cpl.application import ApplicationBuilder + +from simple_startup_app.application import Application +from simple_startup_app.startup import Startup + + +def main(): + app_builder = ApplicationBuilder(Application) + app_builder.use_startup(Startup) + app_builder.build().run() + + +if __name__ == '__main__': + main() diff --git a/src/tests/generated/startup-app/cpl.json b/src/tests/generated/simple-startup-app/src/simple_startup_app/simple-startup-app.json similarity index 72% rename from src/tests/generated/startup-app/cpl.json rename to src/tests/generated/simple-startup-app/src/simple_startup_app/simple-startup-app.json index 086c70ae..6c036f08 100644 --- a/src/tests/generated/startup-app/cpl.json +++ b/src/tests/generated/simple-startup-app/src/simple_startup_app/simple-startup-app.json @@ -1,6 +1,6 @@ { "ProjectSettings": { - "Name": "startup-app", + "Name": "simple-startup-app", "Version": { "Major": "0", "Minor": "0", @@ -16,7 +16,7 @@ "LicenseName": "", "LicenseDescription": "", "Dependencies": [ - "sh_cpl==2021.4.2" + "sh_cpl==2021.4.1rc2" ], "PythonVersion": ">=3.9.2", "PythonPath": { @@ -26,10 +26,10 @@ }, "BuildSettings": { "ProjectType": "console", - "SourcePath": "src", - "OutputPath": "dist", - "Main": "main", - "EntryPoint": "startup-app", + "SourcePath": "", + "OutputPath": "../../dist", + "Main": "simple_startup_app.main", + "EntryPoint": "simple-startup-app", "IncludePackageData": false, "Included": [], "Excluded": [ @@ -37,6 +37,7 @@ "*/logs", "*/tests" ], - "PackageData": {} + "PackageData": {}, + "ProjectReferences": [] } } \ No newline at end of file diff --git a/src/tests/generated/startup-app/src/startup.py b/src/tests/generated/simple-startup-app/src/simple_startup_app/startup.py similarity index 99% rename from src/tests/generated/startup-app/src/startup.py rename to src/tests/generated/simple-startup-app/src/simple_startup_app/startup.py index 07f5dece..8988cf31 100644 --- a/src/tests/generated/startup-app/src/startup.py +++ b/src/tests/generated/simple-startup-app/src/simple_startup_app/startup.py @@ -17,4 +17,3 @@ class Startup(StartupABC): def configure_services(self) -> ServiceProviderABC: return self._services.build_service_provider() - diff --git a/src/tests/generated/simple-startup-app/src/tests/__init__.py b/src/tests/generated/simple-startup-app/src/tests/__init__.py new file mode 100644 index 00000000..ad5eca30 --- /dev/null +++ b/src/tests/generated/simple-startup-app/src/tests/__init__.py @@ -0,0 +1 @@ +# imports: