diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000000000000000000000000000000000000..5dc0b2fcb5c5a83f73d7a79a2e64cd442b311567
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,239 @@
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn. Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+#======================================
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+# Usually these files are written by a python script from a template
+# before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+# For a library or package, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+# However, in case of collaboration, if having platform-specific dependencies or dependencies
+# having no cross-platform support, pipenv may install dependencies that don't work, or not
+# install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+# This is especially recommended for binary packages to ensure reproducibility, and is more
+# commonly ignored for libraries.
+# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+# in version control.
+# https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+# and can be added to the global gitignore or merged into this file. For a more nuclear
+# option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
\ No newline at end of file
diff --git a/JetBrains.gitignore b/JetBrains.gitignore
new file mode 100644
index 0000000000000000000000000000000000000000..3649d6dc25268693224aee006e1c189c009bad14
--- /dev/null
+++ b/JetBrains.gitignore
@@ -0,0 +1,77 @@
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn. Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000000000000000000000000000000000000..cbf1f7e32561c2fb24c588dfd2aabd5950b86324
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) 2023 Schmidt, Christoph
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) 2023 Schmidt, Christoph
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
diff --git a/Python.gitignore b/Python.gitignore
new file mode 100644
index 0000000000000000000000000000000000000000..6769e21d99a63338394e47bc4c7d0aba1e88d5a5
--- /dev/null
+++ b/Python.gitignore
@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+# Usually these files are written by a python script from a template
+# before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+# For a library or package, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+# However, in case of collaboration, if having platform-specific dependencies or dependencies
+# having no cross-platform support, pipenv may install dependencies that don't work, or not
+# install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+# This is especially recommended for binary packages to ensure reproducibility, and is more
+# commonly ignored for libraries.
+# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+# in version control.
+# https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+# and can be added to the global gitignore or merged into this file. For a more nuclear
+# option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
\ No newline at end of file
diff --git a/README.md b/README.md
index 6b363a9e1015a142b89aab56cf909030e21c1f41..d16f14663d2892b02a34afdefda03debe59207aa 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# cmp
+# PySide Multiprocessing
@@ -15,14 +15,14 @@ Already a pro? Just edit this README.md and make it your own. Want to make it ea
```
cd existing_repo
-git remote add origin https://gitlab.tugraz.at/flexsensor-public/modules/cmp.git
+git remote add origin https://gitlab.tugraz.at/flexsensor/pyside-multiprocessing.git
git branch -M main
git push -uf origin main
```
## Integrate with your tools
-- [ ] [Set up project integrations](https://gitlab.tugraz.at/flexsensor-public/modules/cmp/-/settings/integrations)
+- [ ] [Set up project integrations](https://gitlab.tugraz.at/flexsensor/pyside-multiprocessing/-/settings/integrations)
## Collaborate with your team
diff --git a/examples/example1/example1.py b/examples/example1/example1.py
new file mode 100644
index 0000000000000000000000000000000000000000..1148565fcbc1e674e76384ec7938f5b1ae77f253
--- /dev/null
+++ b/examples/example1/example1.py
@@ -0,0 +1,79 @@
+# -*- coding: utf-8 -*-
+"""
+Author(s): Christoph Schmidt <christoph.schmidt@tugraz.at>
+Created: 2023-10-19 12:35
+Package Version:
+"""
+import signal
+import sys
+from multiprocessing import Process, Queue, Pipe
+from threading import Thread
+
+from PySide6.QtCore import QObject, Signal, SIGNAL
+from PySide6.QtWidgets import QDialog, QApplication, QTextBrowser, QLineEdit, QVBoxLayout, QMainWindow, QMessageBox
+
+from mp_process import ChildProc, ChildControl
+
+
+class Form(QDialog):
+
+ on_text_converted = Signal(str)
+
+ def __init__(self, parent=None):
+ super().__init__(parent)
+
+ child_con = ChildControl(self, enable_internal_logging=True)
+
+ child_con.call_without_mp_finished.connect(self.updateUI)
+ child_con.call_without_mp2_changed.connect(self.updateUI2)
+
+
+ self.browser = QTextBrowser()
+ self.lineedit = QLineEdit('Type text and press <Enter>')
+ self.lineedit.selectAll()
+ layout = QVBoxLayout()
+ layout.addWidget(self.browser)
+ layout.addWidget(self.lineedit)
+ self.setLayout(layout)
+ self.lineedit.setFocus()
+ self.setWindowTitle('Upper')
+ #self.lineedit.returnPressed.connect(lambda: child_con.call_without_mp(1, 2, c=3))
+ self.lineedit.returnPressed.connect(lambda: child_con.call_all())
+
+ #self.emitter.register(self.on_text_converted, self.updateUI)
+
+ def test(self):
+ #Signal(str)
+ self.data_to_child.put(self.to_child.__name__)
+ #self.lineedit.clear()
+
+
+ def updateUI(self, text):
+ print("updateUI: ", text)
+ self.browser.append(str(text))
+
+ def updateUI2(self, text, text2, text3):
+ print("updateUI2: ", text)
+ self.browser.append("->" + str(text) + "+" + str(text2) + "=" + str(text3))
+
+ def closeEvent(self, event):
+ print("closeEvent")
+ #try:
+ self.destroyed.emit()
+ #except KeyboardInterrupt:
+ # print("KeyboardInterrupt")
+ #event.ignore()
+
+
+
+if __name__ == '__main__':
+
+ try:
+ app = QApplication(sys.argv)
+ form = Form()
+ form.show()
+ app.exec()
+ except KeyboardInterrupt:
+ print("KeyboardInterrupt")
+ sys.exit(0)
+
diff --git a/examples/example1/mp_process.py b/examples/example1/mp_process.py
new file mode 100644
index 0000000000000000000000000000000000000000..4d93f4f371da9d03be824bba74a2aaf9497e0d99
--- /dev/null
+++ b/examples/example1/mp_process.py
@@ -0,0 +1,66 @@
+# -*- coding: utf-8 -*-
+"""
+Author(s): Christoph Schmidt <christoph.schmidt@tugraz.at>
+Created: 2023-10-19 12:35
+Package Version:
+"""
+import os
+import sys
+import time
+
+from PySide6.QtCore import Signal
+
+sys.path.append('./src')
+import cmp
+
+
+class Sceleton:
+
+ def call_without_mp(self, a, b, c=None, **kwargs):
+ raise NotImplementedError()
+
+
+class ChildProc(cmp.CProcess, Sceleton):
+
+ def __init__(self, state_queue, cmd_queue, enable_interal_logging):
+ super().__init__(state_queue, cmd_queue, enable_interal_logging=enable_interal_logging)
+
+ @cmp.CProcess.register_for_signal()
+ def call_without_mp(self, a, b, c=None, **kwargs):
+ print(f"{os.getpid()} -> call_without_mp with {a}, {b}, {c} and {kwargs}!")
+ time.sleep(1)
+ return c
+
+ @cmp.CProcess.register_for_signal('_changed')
+ def call_without_mp2(self, a, b, c=None, **kwargs):
+ print(f"{os.getpid()} -> call_without_mp2 with {a}, {b}, {c} and {kwargs}!")
+ time.sleep(1)
+ return b, c, b+c
+
+ #@CProccess.register_function
+ def call_all(self, *args, **kwargs):
+ self.call_without_mp(1, 2, c=3)
+ self.call_without_mp2(4, 7, c=5)
+
+
+class ChildControl(cmp.CProcessControl, Sceleton):
+ call_without_mp_finished = Signal(int)
+ call_without_mp2_changed = Signal(int, int, int)
+
+ def __init__(self, parent, enable_internal_logging):
+ super().__init__(parent, enable_internal_logging=enable_internal_logging)
+ self.register_child_process(ChildProc(self.state_queue, self.cmd_queue, enable_interal_logging=enable_internal_logging))
+
+ @cmp.CProcessControl.register_function()
+ def call_without_mp(self, a, b, c=None):
+ pass
+ #print(f"{os.getpid()} -> call_without_mp with {a}, {b}, {c}!")
+
+ @cmp.CProcessControl.register_function()
+ def call_without_mp2(self, a, b, c=None, **kwargs):
+ pass
+
+ @cmp.CProcessControl.register_function()
+ def call_all(self):
+ pass
+ #print(f"{os.getpid()} -> Executing call_all in Control Class.")
diff --git a/examples/example2/ChildProcess2.py b/examples/example2/ChildProcess2.py
new file mode 100644
index 0000000000000000000000000000000000000000..e8b1a75a79e41c334bea6f634af6ed288dfb02c2
--- /dev/null
+++ b/examples/example2/ChildProcess2.py
@@ -0,0 +1,30 @@
+import os
+import time
+
+import cmp
+
+
+class ChildProcess2(cmp.CProcess):
+
+ def __init__(self, state_queue, cmd_queue, enable_interal_logging):
+ super().__init__(state_queue, cmd_queue, enable_interal_logging=enable_interal_logging)
+ self.logger = None
+
+ def postrun_init(self):
+ self.logger, self.logger_h = self.create_new_logger(f"{self.__class__.__name__}-({os.getpid()})")
+ @cmp.CProcess.register_for_signal()
+ def call_without_mp(self, a, b, c=None, **kwargs):
+ self.logger.info(f"{os.getpid()} -> call_without_mp with {a}, {b}, {c} and {kwargs}!")
+ time.sleep(1)
+ return c
+
+ @cmp.CProcess.register_for_signal('_changed')
+ def call_without_mp2(self, a, b, c=None, **kwargs):
+ print(f"{os.getpid()} -> call_without_mp2 with {a}, {b}, {c} and {kwargs}!")
+ time.sleep(1)
+ return b, c, b+c
+
+ #@CProccess.register_function
+ def call_all(self, *args, **kwargs):
+ self.call_without_mp(1, 2, c=3)
+ self.call_without_mp2(4, 7, c=5)
diff --git a/examples/example2/ChildProcessControl2.py b/examples/example2/ChildProcessControl2.py
new file mode 100644
index 0000000000000000000000000000000000000000..50f10cf85d848cd407a444044a74f03e2fc845c8
--- /dev/null
+++ b/examples/example2/ChildProcessControl2.py
@@ -0,0 +1,27 @@
+from PySide6.QtCore import Signal
+
+import cmp
+from ChildProcess2 import ChildProcess2
+
+
+class ChildProcessControl2(cmp.CProcessControl):
+ call_without_mp_finished = Signal(int)
+ #call_without_mp2_changed = Signal(int, int, int)
+
+ def __init__(self, parent, signal_class, enable_internal_logging):
+ super().__init__(parent, signal_class, enable_internal_logging=enable_internal_logging)
+ self.register_child_process(ChildProcess2(self.state_queue, self.cmd_queue, enable_interal_logging=enable_internal_logging))
+
+ @cmp.CProcessControl.register_function()
+ def call_without_mp(self, a, b, c=None):
+ pass
+ #print(f"{os.getpid()} -> call_without_mp with {a}, {b}, {c}!")
+
+ @cmp.CProcessControl.register_function()
+ def call_without_mp2(self, a, b, c=None, **kwargs):
+ pass
+
+ @cmp.CProcessControl.register_function()
+ def call_all(self):
+ pass
+ #print(f"{os.getpid()} -> Executing call_all in Control Class.")
diff --git a/examples/example2/example2.py b/examples/example2/example2.py
new file mode 100644
index 0000000000000000000000000000000000000000..4f389124f5c6ef47c940051cb4d096da47cf3f4a
--- /dev/null
+++ b/examples/example2/example2.py
@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+"""
+Author(s): Christoph Schmidt <christoph.schmidt@tugraz.at>
+Created: 2023-10-19 12:35
+Package Version:
+"""
+import signal
+import sys
+from multiprocessing import Process, Queue, Pipe
+from threading import Thread
+
+from PySide6.QtCore import QObject, Signal, SIGNAL
+from PySide6.QtWidgets import QDialog, QApplication, QTextBrowser, QLineEdit, QVBoxLayout, QMainWindow, QMessageBox
+
+sys.path.append('./src')
+from ChildProcessControl2 import ChildProcessControl2
+
+
+class MySignals(QObject):
+ def __init__(self, parent=None):
+ super().__init__(parent)
+
+ call_without_mp2_changed = Signal(int, int, int)
+
+
+class Form(QDialog):
+ on_text_converted = Signal(str)
+
+ def __init__(self, parent=None):
+ super().__init__(parent)
+
+ mysignals = MySignals()
+ child_con = ChildProcessControl2(self, mysignals, enable_internal_logging=False)
+
+ mysignals.call_without_mp2_changed.connect(self.updateUI)
+
+ self.browser = QTextBrowser()
+ self.lineedit = QLineEdit('Type text and press <Enter>')
+ self.lineedit.selectAll()
+ layout = QVBoxLayout()
+ layout.addWidget(self.browser)
+ layout.addWidget(self.lineedit)
+ self.setLayout(layout)
+ self.lineedit.setFocus()
+ self.setWindowTitle('Upper')
+ # self.lineedit.returnPressed.connect(lambda: child_con.call_without_mp(1, 2, c=3))
+ self.lineedit.returnPressed.connect(lambda: child_con.call_all())
+
+ def updateUI(self, text, text2, text3):
+ print("updateUI: ", text)
+ self.browser.append("->" + str(text) + "+" + str(text2) + "=" + str(text3))
+
+
+if __name__ == '__main__':
+
+ try:
+ app = QApplication(sys.argv)
+ form = Form()
+ form.show()
+ app.exec()
+ except KeyboardInterrupt:
+ print("KeyboardInterrupt")
+ sys.exit(0)
diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 0000000000000000000000000000000000000000..9a19b982d91bef7bada5ab7f700ab690172a98e2
--- /dev/null
+++ b/pyproject.toml
@@ -0,0 +1,20 @@
+[project]
+name = "cmp"
+version = "0.0.1"
+authors = [
+ { name="Christoph Schmidt", email="cschmidt.fs@gmail.com" },
+]
+description = "A Pyside-to-Process Controll class"
+readme = "README.md"
+requires-python = ">=3.7"
+dependencies = [
+ 'pyside6', 'pyyaml'
+]
+classifiers = [
+ "Programming Language :: Python :: 3",
+ "License :: OSI Approved :: GNU General Public License v3.0",
+ "Operating System :: OS Independent",
+]
+
+[project.urls]
+"Homepage" = "https://gitlab.tugraz.at/flexsensor-public/---"
\ No newline at end of file
diff --git a/src/__init__.py b/src/__init__.py
new file mode 100644
index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391
diff --git a/src/cmp/CCommandRecord.py b/src/cmp/CCommandRecord.py
new file mode 100644
index 0000000000000000000000000000000000000000..8253c38fa19d2da66c51b8a4d709c9fc34d9a08d
--- /dev/null
+++ b/src/cmp/CCommandRecord.py
@@ -0,0 +1,23 @@
+from cmp import CProcess as CProcess
+
+
+class CCommandRecord:
+ def __init__(self, func_name: str, *args: (), **kwargs: {}):
+ self.func_name: str = func_name
+ self.args: () = args
+ self.kwargs: {} = kwargs
+
+ self.signal_name: str = None
+
+ def _register_signal(self, signal_name: str):
+ self.signal_name: str = signal_name
+
+ def execute(self, class_object: CProcess):
+ class_object._internal_logger.info(f"Executing {self} in {class_object.name}.\n")
+ getattr(class_object, self.func_name)(*self.args, **self.kwargs)
+
+ def __repr__(self):
+ args_str = ', '.join(map(repr, self.args))
+ kwargs_str = ', '.join(f"{key}={repr(value)}" for key, value in self.kwargs.items())
+ all_args = ', '.join(filter(None, [args_str, kwargs_str]))
+ return f"Function {self.func_name}({all_args})"
\ No newline at end of file
diff --git a/src/cmp/CProcess.py b/src/cmp/CProcess.py
new file mode 100644
index 0000000000000000000000000000000000000000..6961d9be8eed27e8434fea585d4948a1c8b1d24a
--- /dev/null
+++ b/src/cmp/CProcess.py
@@ -0,0 +1,122 @@
+import logging.handlers
+import logging
+import os
+import time
+import traceback
+from multiprocessing import Process, Queue, Value
+
+import cmp
+
+
+class CProcess(Process):
+
+ def __init__(self, state_queue: Queue, cmd_queue: Queue, enable_internal_logging=True):
+ Process.__init__(self)
+
+ self._enable_internal_logging = enable_internal_logging
+ self.logger = None
+ self.logger_handler = None
+
+ self._internal_logger = None
+ self._il_handler = None
+
+ self.cmd_queue = cmd_queue
+ self.state_queue = state_queue
+ self._kill_flag = Value('i', 1)
+
+ def register_kill_flag(self, kill_flag: Value):
+ self._kill_flag = kill_flag
+
+ def create_new_logger(self, name: str) -> (logging.Logger, logging.Handler):
+ _handler = logging.handlers.QueueHandler(self.state_queue)
+ _logger = logging.getLogger(name)
+ _logger.handlers.clear()
+ _logger.handlers = [_handler]
+ _logger.setLevel(logging.DEBUG)
+ formatter = logging.Formatter('%(message)s')
+ _handler.setFormatter(formatter)
+ return _logger, _handler
+
+ def enable_internal_logging(self, enable: bool):
+ self._enable_internal_logging = enable
+ if self._internal_logger is not None and enable is False:
+ self._internal_logger.disabled = True
+ #self._internal_logger.handlers = []
+ elif self._internal_logger is not None and enable is True:
+ self._internal_logger.disabled = False
+ #self._internal_logger.handlers = [self._il_handler]
+
+ def postrun_init(self):
+ """
+ Dummy function for initializing e.g. loggers (some handlers are not pickable)
+ or pther non-pickable objects
+ """
+ pass
+
+ def run(self):
+ self.name = f"{self.name}/{os.getpid()}"
+ self.postrun_init()
+
+ self._internal_logger, self._il_handler = self.create_new_logger(f"{self.__class__.__name__}-Int({os.getpid()})")
+ self.logger, self.logger_handler = self.create_new_logger(f"{self.__class__.__name__}({os.getpid()})")
+ self.enable_internal_logging(self._enable_internal_logging)
+ try:
+ while self._kill_flag.value:
+ try:
+ cmd = self.cmd_queue.get(block=True, timeout=1)
+ except:
+ continue
+ if isinstance(cmd, cmp.CCommandRecord):
+ self._internal_logger.info(f"Received cmd: {cmd}")
+ # print(f"Received cmd with args: {cmd_with_args}")
+ # cmd = cmd_with_args['func']
+ # args = cmd_with_args['args']
+ # kwargs = cmd_with_args['kwargs']
+ # if 'sig_name' is not None:
+ # #sig_name = cmd_with_args['sig_name']
+ self._internal_logger.debug(
+ f"cmd: {cmd}, args: {cmd.args}, kwargs: {cmd.kwargs}, sig_name: {cmd.signal_name}")
+ try:
+ cmd.execute(self)
+ except Exception as e:
+ traceback_str = ''.join(traceback.format_tb(e.__traceback__))
+ self._internal_logger.error(f"Exception '{e}' occurred in {cmd}!. Traceback:\n{traceback_str}")
+ # else:
+ # self._internal_logger.debug(f"cmd: {cmd}, args: {cmd.args}, kwargs: {cmd.kwargs}")
+ # self._internal_logger.info(f"Executing {cmd} in Process Class.\n")
+ # getattr(self, cmd.func_name)(*cmd.args, **cmd.kwargs)
+ self._internal_logger.error(f"Control Process exited. Terminating Process {os.getpid()}")
+
+ except KeyboardInterrupt:
+ self._internal_logger.warning(f"Received KeyboardInterrupt! Exiting Process {os.getpid()}")
+ time.sleep(1)
+ self.close()
+ except Exception as e:
+ self._internal_logger.warning(f"Received Exception {e}! Exiting Process {os.getpid()}")
+
+ def __del__(self):
+ # if self._internal_logger is not None:
+ # self._internal_logger.warning(f"Exiting Process")
+ self.cmd_queue.close()
+ self.state_queue.close()
+
+ @staticmethod
+ def register_for_signal(postfix='_finished'):
+ def register(func):
+ def get_signature(self, *args, **kwargs):
+ res = func(self, *args, **kwargs)
+
+ # arguments = locals().copy()
+ # print(f"arguments: {arguments}")
+ # if 'sig_name' in arguments:
+ if 'sig_name' in kwargs and kwargs['sig_name'] is None:
+ sign = kwargs['sig_name']
+ else:
+ sign = f"{func.__name__}{postfix}"
+ result = cmp.CResultRecord(sign, res)
+ self.state_queue.put(result)
+ return res
+
+ return get_signature
+
+ return register
diff --git a/src/cmp/CProcessControl.py b/src/cmp/CProcessControl.py
new file mode 100644
index 0000000000000000000000000000000000000000..18672b5c568c51b3739e1fc94717c19a6210d4f9
--- /dev/null
+++ b/src/cmp/CProcessControl.py
@@ -0,0 +1,131 @@
+import logging
+import logging.handlers
+import os
+import signal
+import time
+from multiprocessing import Queue, Process, Value
+
+from PySide6.QtCore import QObject, QThreadPool
+from PySide6.QtGui import QWindow
+from PySide6.QtWidgets import QWidget
+from rich.logging import RichHandler
+
+import cmp
+
+
+class CProcessControl(QObject):
+
+ def __init__(self, kill_child_process_flag: Value,
+ parent: QObject = None,
+ signal_class: QObject = None,
+ enable_internal_logging: bool = False):
+ super().__init__(parent)
+ self._kill_child_process_flag = kill_child_process_flag
+ self._enable_internal_logging = enable_internal_logging
+
+ if parent is not None:
+ parent.destroyed.connect(self.safe_exit)
+
+ # Register this class as signal class (all signals will be implemented and emitted from this class)
+ if signal_class is not None:
+ self.register_signal_class(signal_class)
+ else:
+ self.register_signal_class(self)
+
+
+ # The child process
+ self._child: Process = None
+ # Queues for data exchange
+ self.cmd_queue = Queue()
+ self.state_queue = Queue()
+
+ # Thread manager for monitoring the state queue
+ self.thread_manager = QThreadPool()
+
+ # The child process pid
+ self._child_process_pid = None
+ self._child_kill_flag = Value('i', 1)
+
+ self._internal_logger, self._il_handler = self.create_new_logger(f"{self.__class__.__name__}-Int({os.getpid()})")
+ self.logger, self.logger_handler = self.create_new_logger(f"{self.__class__.__name__}({os.getpid()})")
+ self.enable_internal_logging(enable_internal_logging)
+
+ def create_new_logger(self, name: str) -> (logging.Logger, logging.Handler):
+ qh = RichHandler(rich_tracebacks=True)
+ _internal_logger = logging.getLogger(name)
+ _internal_logger.handlers = [qh]
+ _internal_logger.setLevel(logging.DEBUG)
+ formatter = logging.Formatter(
+ '%(name)s %(message)s')
+ qh.setFormatter(formatter)
+ return _internal_logger, qh
+
+ def enable_internal_logging(self, enable: bool):
+ self._enable_internal_logging = enable
+ if self._internal_logger is not None:
+ self._internal_logger.disabled = not enable
+
+ def register_signal_class(self, signal_class: QObject):
+ self._signal_class = signal_class
+
+ @property
+ def child_process_pid(self):
+ return self._child_process_pid
+
+ def register_child_process(self, child: cmp.CProcess):
+ self._child = child
+ self._child.register_kill_flag(self._child_kill_flag)
+ self._child_process_pid = child.pid
+ self._child.enable_internal_logging(self._enable_internal_logging)
+ self._child.start()
+ self.thread_manager.start(self._monitor_result_state)
+
+ def _monitor_result_state(self):
+ self._internal_logger.info("Starting monitor thread.")
+ try:
+ while self._child.is_alive():
+ try:
+ res = self.state_queue.get(block=True, timeout=1)
+ except:
+ continue
+
+ if isinstance(res, logging.LogRecord):
+ try:
+ self.logger.handle(res)
+ except Exception as e:
+ self.logger.warning(f"Error cannot handle log record: {e}")
+ elif isinstance(res, cmp.CResultRecord):
+ try:
+ res.emit_signal(self._signal_class)
+ self._internal_logger.debug(f"Emitted {res} in {self._signal_class.__class__.__name__}.")
+ except Exception as e:
+ self._internal_logger.error(f"Error while emitting {res} in {self.__class__.__name__}: {e}")
+ except:
+ print(f"Error in monitor thread")
+ time.sleep(1)
+
+ self._internal_logger.info("Ended monitor thread.")
+ self.state_queue.close()
+ self.cmd_queue.close()
+
+ @staticmethod
+ def register_function(signal_name: str = None):
+ def register(func):
+ def get_signature(self: CProcessControl, *args, **kwargs):
+ arguments = locals().copy()
+ arguments.pop("func")
+
+ args = arguments.pop("args")
+ kwargs = arguments.pop("kwargs")
+ name = getattr(func, '__name__', 'unknown')
+ cmd = cmp.CCommandRecord(name, *args, **kwargs)
+ func(self, *args, **kwargs)
+ self.cmd_queue.put(cmd)
+ return get_signature
+ return register
+ def safe_exit(self):
+ self._internal_logger.warning(f"Shutting down ProcessControl {os.getpid()}")
+ self._child_kill_flag.value = 0
+
+ def __del__(self):
+ self._internal_logger.warning(f"Closing ProcessControl {self.__class__.__name__} with pid {os.getpid()}")
diff --git a/src/cmp/CResultRecord.py b/src/cmp/CResultRecord.py
new file mode 100644
index 0000000000000000000000000000000000000000..cc3d6310a62a2ab1d81659f32ac2024f536798d3
--- /dev/null
+++ b/src/cmp/CResultRecord.py
@@ -0,0 +1,32 @@
+from inspect import Signature, Parameter
+
+from cmp import CProcessControl as CProcessControl
+
+
+class CResultRecord:
+
+ def __init__(self, signal_name: str, result):
+ self.signal_name: str = signal_name
+ self.result = result
+
+ def emit_signal(self, class_object: CProcessControl):
+ if hasattr(class_object, '_internal_logger'):
+ class_object._internal_logger.info(f"Emitting {self} in {class_object.__class__.__name__}.")
+ emitter = getattr(class_object, self.signal_name).emit
+ if isinstance(self.result, tuple):
+ emitter(*self.result)
+ elif self.result is None:
+ emitter()
+ else:
+ emitter(self.result)
+
+
+ def __repr__(self):
+ if isinstance(self.result, tuple):
+ args_str = ', '.join(map(repr, self.result))
+ else:
+ args_str = repr(self.result)
+ # shorten arg_str if too long
+ if len(args_str) > 100:
+ args_str = args_str[0:10] + '...' + args_str[-10:]
+ return f"Signal {self.signal_name}({args_str})"
diff --git a/src/cmp/__init__.py b/src/cmp/__init__.py
new file mode 100644
index 0000000000000000000000000000000000000000..cb22ac4863086c7a6e4446958d351976b0f3d898
--- /dev/null
+++ b/src/cmp/__init__.py
@@ -0,0 +1,13 @@
+import logging
+import os
+import sys
+
+from rich.logging import RichHandler
+
+from .CCommandRecord import CCommandRecord
+from .CResultRecord import CResultRecord
+
+from .CProcess import CProcess
+from .CProcessControl import CProcessControl
+
+sys.path.append(os.path.join(os.path.dirname(__file__), '../'))