Buddies
/
frank
Archived
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge branch 'release-0.1' into master

master v0.1
Jef Roosens 2020-08-26 15:09:09 +02:00
parent fda5e1b3d7 3986e68b6b
commit 6099b4112c
27 changed files with 1453 additions and 159 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored 100755 → 100644
View File

@ -4,6 +4,9 @@ venv/
# Python built packages
dist/
build/
*.egg-info/
*.eggs/
# Docs output
docs/build

9
CHANGELOG.md 100644
View File

@ -0,0 +1,9 @@
# Changelog
## 0.1 (2020/08/26)
### Added
- Prefix can now be passed as argument to init
- Pre-made help module
### Fixed
- Buggy 'default' cached_property

674
LICENSE 100644
View File

@ -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) <year> <name of author>
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) <year> <name of author>
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>.

70
Makefile 100755 → 100644
View File

@ -1,52 +1,26 @@
# =====CONFIG=====
# File to run when make run is called
MAIN=main.py
# Source directory
SRC=frank
# Directory name of the venv
# Don't put spaces in the VENV name, make does not like spaces
# Run make clean first if you do this after already having created a venv
# Run make clean first if you change this after already having created a venv
VENV=venv
# Docs directory
DOCS=docs
# Tests directory
TESTS=tests
# Interpreter to create venv with
INTERPRETER=python3.8
# Docker image name:tag
IMAGE='chewingbever/frank:latest'
all: run
# Re-create venv when needed
$(VENV)/bin/activate: requirements.txt
$(VENV)/bin/activate: requirements.txt requirements-dev.txt
@ echo "Rebuilding venv..."
@ [ ! -e "$(VENV)" ] || rm -rf "$(VENV)"
@ "$(INTERPRETER)" -m venv "$(VENV)"
@ "$(VENV)/bin/pip" install -r requirements.txt
@ "$(VENV)/bin/pip" install -r requirements.txt -r requirements-dev.txt
build: $(VENV)/bin/activate
# Run script
run: build
@ "$(VENV)/bin/python" "$(MAIN)"
# =====DOCKER=====
# Build docker image
dbuild: docker/Dockerfile
@ docker build -f docker/Dockerfile -t $(IMAGE) .
# Run docker
drun: dbuild docker/docker-compose.yml
@ docker-compose -f docker/docker-compose.yml up
# run docker as daemon
drund: dbuild docker/docker-compose.yml
@ docker-compose -f docker/docker-compose.yml up -d
dpush: dbuild
@ docker push $(IMAGE)
build-venv: $(VENV)/bin/activate
# =====CLEANING=====
clean: clean-venv clean-cache clean-docs
@ -67,36 +41,38 @@ clean-docs:
@ echo "Removing documentation build..."
@ [ ! -e "$(DOCS)/build" ] || rm -r "$(DOCS)/build"
clean-setup:
@ echo 'Removing build artifacts...'
@ [ ! -e "build" ] || rm -rf build
@ find . -maxdepth 1 -type d -name '*.egg-info' -exec rm -rf "{}" \;
# =====DOCS=====
$(VENV)/bin/sphinx-build: build
@ echo "Installing sphinx..."
@ "$(VENV)/bin/pip" install --quiet sphinx
docs: $(VENV)/bin/sphinx-build
docs: build-venv
@ "$(VENV)/bin/sphinx-apidoc" -o "$(DOCS)/source" "$(SRC)"
@ "$(VENV)/bin/sphinx-build" "$(DOCS)/source" "$(DOCS)/build"
# =====TESTS=====
$(VENV)/bin/pytest: build
@ echo "Installing pytest..."
@ "$(VENV)/bin/pip" install --quiet pytest
test: pytest.ini build
test: pytest.ini build-venv
@ "$(VENV)/bin/pytest" --color=yes
# =====PACKAGING=====
package: README.md LICENSE setup.py test
package: README.md LICENSE setup.py test clean-setup
@ echo "Removing build..."
@ [ ! -e "dist" ] || rm -r "dist"
@ echo "Updating wheel & setuptools..."
@ "$(VENV)/bin/pip" install --upgrade --quiet setuptools wheel
@ echo "Running setup.py..."
@ "$(VENV)/bin/python" setup.py sdist bdist_wheel
# Publish will also come here someday
publish: package
@ [ git symbolic-ref HEAD --short = master ] && { \
echo 'Publishing to PyPi...'; \
$(VENV)/bin/python -m twine upload dist/* ; \
} || { \
echo 'Publishing to PyPi Testing...'; \
$(VENV)/bin/python -m twine upload --repository testpypi dist/* ; \
}
.PHONY: all run clean clean-venv clean-cache clean-docs test package docs \
build dbuild drun dpush drund
.PHONY: all clean clean-venv clean-cache clean-docs test package docs \
build-venv run-venv clean-setup

77
README.md 100644
View File

@ -0,0 +1,77 @@
# Frank
## Description
Playing around with creating a Discord bot is a fun pass-time, and a good way to learn a programming language. Sadly,
however, discord.py can be a little hard to work with at times. That's when I got the idea to create Frank. The goal of
Frank is to make creating Discord bots easier. It handles all the bot-related stuff in the background, so you can focus
on writing the functionality of the bot itself, not how the bot works/interacts with Discord.
Frank works by dividing the bot into modules. Each module has its own prefix, commands, and daemons. Frank handles
routing the Discord commands to their respective functions.
## Example Module
In this section, I've written an example module for you, to understand the basic mechanics behind Frank.
```python
import frank
class ExampleMod(frank.Module):
PREFIX = 'examp'
NAME = 'example'
HELP = 'an example module'
```
This first part shows the three important variables in any module.
- PREFIX defines the string used to use the commands defined in this module. This means you can use the module as such
inside your Discord server:
```
fr examp [NAME_OF_COMMAND] [ARGS]
```
With fr being the default prefix for Frank (can be overwritten). As you define more modules, they should all have a
unique prefix. This is how Frank's modular system works, and any modules added to the list will automatically be
picked up by Frank. The PREFIX value can also be list, allowing for multiple prefixes: for example a long,
description one, and a short, easy to type one (e.g. minecraft and mc).
```python
def pre_start(self):
self.some_var = 'a value needed for working'
```
The pre_start function is where you define any variables which should be created before any daemons are started or
commands are run. I don't recommend overwriting `__init__`, as this might break compatibility with future versions of
Frank.
```python
@frank.command('command', help_str='a small description of the command')
async def some_command(self, cmd, author, channel, mid):
# do some stuff
pass
@frank.daemon()
async def some_daemon(self):
while True:
# do some stuff
pass
@frank.default()
async def default_cmd(self):
# do some default action
pass
```
These three decorators are the bread and butter of Frank. Let's break them down:
- `frank.command` defines a command. The first argument is its keyword, which will be used to execute the command. The
help_str value is used in the help command, to show some information about the module. The syntax is the same as
before:
```
fr examp command [ARGS]
```
This is how you can define as many Discord commands as you want, without needing to know how to parse the messages
etc. Each command gets the `author`, `channel`, and `id` of the message. The `cmd` variable contains all the arguments passed
to the command.
- `frank.daemon` defines a daemon, a process that should run in the background for as long as the bot is active. It
should contain a while loop and preferably a sleep function using `asyncio.sleep()` (there are plans to improve this
behavior). Because a daemon is just a method of the module class, it has access to all class variables, including
those defined in `pre_start`.
- `frank.default` defines the command that should be run if the module is called without explicitely giving a command.
For example, if you call `fr examp` without specifying a command, it will run the default command. This is useful for
making a command that's used very often easier to execute.

18
frank/__init__.py
View File

@ -1,2 +1,18 @@
from .frank import Frank
from .module import Module
from .module import (
Module, command, Command, default, Default, daemon, Daemon,
regex_command, RegexCommand,
)
__all__ = [
'Frank',
'Module',
'command',
'Command',
'default',
'Default',
'daemon',
'Daemon',
'regex_command',
'RegexCommand',
]

81
frank/frank.py
View File

@ -1,27 +1,56 @@
# =====IMPORTS=====
# Future imports
from __future__ import annotations
# Built-in imports
import shlex
from typing import List
import discord
# Third-party imports
import yaml
import discord
# Typing imports
from typing import TYPE_CHECKING, List
if TYPE_CHECKING:
# Own imports
from .module import Module
from discord import Message
class Frank(discord.Client):
PREFIX = "fr"
"""
Main class of the bot; works by adding modules, which all define
their own behavior.
"""
def __init__(self, modules: List[Module], config_file: str = 'frank.yaml',
prefix: str = 'fr'):
"""
Args:
modules: modules to load
config_file: path to yaml config file; ignored if non-existent
prefix: prefix to activate Frank in the Discord server
"""
def __init__(self, modules: List["Module"],
config_file: str = "frank.yaml"):
super().__init__()
self._modules = modules
self._loaded_modules = []
self.PREFIX = prefix
try:
with open(config_file, "r") as f:
with open(config_file, 'r') as f:
self._config = yaml.load(f, Loader=yaml.FullLoader)
except FileNotFoundError:
self._config = None
async def on_ready(self):
print("Connected")
"""
Runs when the bot has succesfully connected to Discord
"""
print('Connected')
# Startup all modules
for module in self._modules:
@ -31,20 +60,38 @@ class Frank(discord.Client):
else:
loaded = module(self)
await loaded.start()
await loaded._start()
self._loaded_modules.append(loaded)
print("All modules loaded")
print('All modules loaded')
async def on_message(self, message: str):
cmd = shlex.split(message.content.strip())
async def stop(self):
"""
Stop all module daemons and exit.
"""
if cmd[0] == self.PREFIX:
matched_mods = (
mod for mod in self._loaded_modules if mod.match(cmd[1])
)
for module in self._loaded_modules:
await module.stop()
module = next(matched_mods, None)
async def on_message(self, message: Message):
"""
Runs when a new message is sent in the Discord channel.
Args:
message: object representing the received message; see
https://discordpy.readthedocs.io/en/latest/api.html#message
"""
try:
cmd = shlex.split(message.content.strip())
except ValueError:
return
if cmd and cmd[0] == self.PREFIX:
module = next((mod for mod in self._loaded_modules
if mod.match(cmd[1])), None)
if module:
await module.command(cmd[2:])
await module(cmd=cmd[2:], author=message.author,
channel=message.channel, mid=message.id)

32
frank/module.py
View File

@ -1,32 +0,0 @@
from typing import List, Dict
class Module:
PREFIX = []
NAME = ""
def __init__(self, client: "Frank", config: Dict = None):
self._client = client
self._config = config
async def start(self):
pass
async def command(self, cmd: List[str]):
pass
@classmethod
def match(cls, s: str) -> bool:
"""
Checks wether the given string is a prefix in the module.
"""
if cls.PREFIX:
if isinstance(cls.PREFIX, list):
return s in cls.PREFIX
else:
return s == cls.PREFIX
else:
return False

18
frank/module/__init__.py 100644
View File

@ -0,0 +1,18 @@
from .module import Module
from .decorators import (
command, Command, default, Default, daemon, Daemon, regex_command,
RegexCommand,
)
__all__ = [
'Module',
'command',
'Command',
'default',
'Default',
'daemon',
'Daemon',
'regex_command',
'RegexCommand',
]

13
frank/module/decorators/__init__.py 100644
View File

@ -0,0 +1,13 @@
from .classes import Command, RegexCommand, Daemon, Default
from .functions import command, regex_command, daemon, default
__all__ = [
'command',
'Command',
'regex_command',
'RegexCommand',
'default',
'Default',
'daemon',
'Daemon',
]

120
frank/module/decorators/classes.py 100644
View File

@ -0,0 +1,120 @@
# =====IMPORTS=====
# Future imports
from __future__ import annotations
# Built-in imports
import re
class Simple:
"""
Acts as a base class for all other types; behaves like the given
function
"""
def __init__(self, func: callable):
"""
Args:
func: function to mimic
"""
self.func = func
def __call__(self, *args, **kwargs):
"""
All this call does is call the wrapped function. Because we overwrote
__get__, we can pass self to the function, making it behave as a class
method of the instance calling it.
"""
return self.func.__call__(self._obj, *args, **kwargs)
def __get__(self, instance, owner) -> Simple:
"""
We use __get__ to get the class calling the function. This allows us to
pass 'self' to the wrapped function, effectively making this class
fully behave as a class method.
Args:
instance: instance calling the function
owner: type of the function
"""
self._cls = owner
self._obj = instance
return self
class Command(Simple):
"""
Represents a command of the module.
"""
def __init__(self, func: callable, cmd: str, help_str: str = None):
"""
Args:
func: function to wrap
cmd: keyword used to call this function
help_str: short description of the command
"""
super().__init__(func)
self.cmd = cmd
self.help_str = help_str
def match(self, prefix: str) -> bool:
"""
Returns wether the command matches the given prefix.
Args:
prefix: string to match own prefix against
"""
return self.cmd == prefix
class RegexCommand(Command):
"""
A subclass of Command that can use a regex pattern instead of a fixed
prefix.
"""
def match(self, prefix: str) -> bool:
"""
Returns wether the regex pattern matches the given prefix.
Args:
prefix: string to match pattern against; Pattern must match entire
prefix
"""
return bool(re.fullmatch(self.cmd, prefix))
class Daemon(Simple):
"""
Represents a daemon. Currently, it's only used as its own type, but writing
it this way allows us to easily expand upon its functionality later.
"""
pass
class Default(Simple):
"""
Represents a default command (a.k.a. when the module is called without a
command.
"""
def __init__(self, func: callable, help_str: str = None):
"""
Args:
func: function to wrap
help_str: short description of the default command
"""
super().__init__(func)
self.help_str = help_str

58
frank/module/decorators/functions.py 100644
View File

@ -0,0 +1,58 @@
# =====IMPORTS=====
# Own imports
from .classes import Command, RegexCommand, Daemon, Default
def command(cmd, help_str: str = None) -> callable:
"""
Converts a method into a command by replacing it with a Command object.
Args:
cmd: keyword used to call this function
help_str: short description of the command
"""
def inner(func):
return Command(func, cmd, help_str)
return inner
def regex_command(pattern: str, help_str: str = None) -> callable:
"""
Converts the method into a RegexCommand.
Args:
pattern: regex pattern to match command with
help_str: short description of the command
"""
def inner(func):
return RegexCommand(func, pattern, help_str)
return inner
def daemon() -> callable:
"""
Converts the method into a Daemon, which will then be run when the module
is started.
"""
def inner(func):
return Daemon(func)
return inner
# TODO: make sure the default is unique
def default(help_str: str = None) -> callable:
"""
Converts the method into the Default method, making it the default command
when the module is run without a command.
"""
def inner(func):
return Default(func, help_str)
return inner

10
frank/module/exceptions.py 100644
View File

@ -0,0 +1,10 @@
class InvalidCommand(Exception):
pass
class DuplicateCommand(Exception):
pass
class MultipleDefaults(Exception):
message = 'Multiple default commands detected'

49
frank/module/meta.py 100644
View File

@ -0,0 +1,49 @@
# =====IMPORTS=====
# Future imports
from __future__ import annotations
# Built-in imports
from functools import cached_property
# Own imports
from .decorators import Command, Daemon, Default, RegexCommand
# Typing imports
from typing import TYPE_CHECKING
if TYPE_CHECKING:
# Built-in imports
from typing import List, Any
class ModuleMeta:
def _filter_attrs(self, condition: callable[[Any], bool]) -> List[Any]:
# This prevents an infinite loop of getting the attribute
illegal_names = ['commands', 'daemons', 'default']
output = []
for attr in filter(lambda x: x not in illegal_names, dir(self)):
value = getattr(self, attr)
if condition(value):
output.append(value)
return output
@cached_property
def commands(self) -> List[Command]:
# This also matches RegexCommand objects
# The sort puts all the RegexCommand objects at the back, making them
# be matched last
return sorted(self._filter_attrs(lambda val: isinstance(val, Command)),
key=lambda x: isinstance(x, RegexCommand))
@cached_property
def daemons(self) -> List[Daemon]:
return self._filter_attrs(lambda val: isinstance(val, Daemon))
@cached_property
def default(self) -> Default:
return next(iter(self._filter_attrs(
lambda val: isinstance(val, Default))), None)

136
frank/module/module.py 100644
View File

@ -0,0 +1,136 @@
# =====IMPORTS=====
# Future imports
from __future__ import annotations
# Built-in imports
import asyncio
# Own imports
from .exceptions import InvalidCommand
from .meta import ModuleMeta
from .decorators import RegexCommand
# Typing imports
from typing import TYPE_CHECKING
if TYPE_CHECKING:
# Built-in imports
from typing import List, Dict
# Third-party imports
from discord.abc import User, Messageable
# Own imports
from suzybot.frank import Frank
class Module(ModuleMeta):
"""
Base class for modules; all custom modules should inherit from this.
"""
PREFIX = []
"""
Prefix to activate this module.
"""
NAME = ''
"""
The name is used in various places, such as the config file and the
help function.
"""
HELP = ''
"""
Short description of the module to use in the help function.
"""
def __init__(self, client: Frank, config: Dict = None):
"""
Args:
client: client using this module; used to communicate.
config: dict containing the config for this module (Frank client
reads this from the config file).
"""
super().__init__()
self._client = client
self._config = config
self._tasks = []
def pre_start(self):
"""
Overwrite this function to run code (e.g. add variables...) before
starting the daemons.
"""
pass
async def _start(self):
"""Start up defined daemons for this module."""
self.pre_start()
for daemon in self.daemons: # pylint: disable=no-member
task = asyncio.create_task(daemon())
self._tasks.append(task)
async def stop(self):
"""
Stop all tasks for this module.
"""
for task in self._tasks:
task.cancel()
async def __call__(self, cmd: List[str], author: User,
channel: Messageable, mid: int):
"""
Execute the command, if found.
Args:
cmd: list of command arguments; if empty, default command is used
author: author of message
channel: channel the message was sent in
mid: message id
"""
if cmd:
func = next((func for func in self.commands
if func.match(cmd[0])), None)
if func:
# A RegexCommand can use the prefix, as it's not a fixed string
if isinstance(func, RegexCommand):
await func(prefix=cmd[0], cmd=cmd[1:], author=author,
channel=channel, mid=mid)
else:
await func(cmd=cmd[1:], author=author, channel=channel,
mid=mid)
else:
raise InvalidCommand(f'Unknown command: {cmd}')
elif self.default:
await self.default(author=author, channel=channel, mid=mid)
@classmethod
def match(cls, prefix: str) -> bool:
"""
Checks wether the given prefix matches the module.
Args:
prefix: prefix to check
"""
if cls.PREFIX:
if isinstance(cls.PREFIX, list):
return prefix in cls.PREFIX
else:
return prefix == cls.PREFIX
else:
return False

8
frank/modules/__init__.py
View File

@ -1,2 +1,6 @@
from .testmod import TestMod
from .mcstat import McStat
from .help import HelpMod
__all__ = [
'HelpMod',
]

58
frank/modules/help.py 100644
View File

@ -0,0 +1,58 @@
# =====IMPORTS=====
# Future imports
from __future__ import annotations
# Third-party imports
from discord import Embed
# Own imports
from .. import Module, default, regex_command
# Typing imports
from typing import TYPE_CHECKING
if TYPE_CHECKING:
# Built-in imports
from typing import List
# Third-party imports
from discord.abc import User, Messageable
class HelpMod(Module):
"""
This module sends a help message in a given channel with info about all
other modules.
"""
PREFIX = 'help'
NAME = 'help'
HELP = 'Shows help info about all modules'
@default(help_str='Show help about all modules.')
async def send_all(self, author: User, channel: Messageable, mid: int):
embed = Embed()
for mod in self._client._modules:
embed.add_field(name=mod.NAME, value=mod.HELP, inline=False)
await channel.send(embed=embed)
@regex_command(cmd='.+', help_str='Show help about a certain module.')
async def show_module_help(self, prefix: str, cmd: List[str], author: User,
channel: Messageable, mid: int):
# Yes, this command just ignores cmd at the moment
mod_name = prefix.lower()
mod = next((mod for mod in self._client._modules
if mod.NAME.lower() == mod_name), None)
if mod:
embed = Embed()
if mod.default:
embed.add_field(name='default', value=mod.default.help_str,
inline=False)
for cmd in mod._COMMANDS:
embed.add_field(name=cmd.cmd, value=mod.help_str, inline=False)
await channel.send(embed=embed)

32
frank/modules/mcstat.py
View File

@ -1,32 +0,0 @@
from .. import Module
from mcstatus import MinecraftServer
class McStat(Module):
PREFIX = "mc"
NAME = "mcstat"
async def command(self, cmd):
if cmd[0] == "online":
address = self._config["domain"]
port = self._config.get("port")
if port:
address += ":" + str(port)
server = MinecraftServer.lookup(address)
status = server.status()
if status.players.sample is not None:
players = [player.name for player in status.players.sample]
else:
players = None
channel = self._client.get_channel(self._config["channel_id"])
if players:
await channel.send(f'Currently online: {",".join(players)}')
else:
await channel.send("No one is here bro")

12
frank/modules/testmod.py
View File

@ -1,12 +0,0 @@
from typing import List
from .. import Module
class TestMod(Module):
PREFIX = "test"
NAME = "test"
async def command(self, cmd: List[str]):
if cmd[0] == "test":
channel = self._client.get_channel(self._config["channel_id"])
await channel.send("psycho frank is in the house")

10
main.py
View File

@ -1,10 +0,0 @@
import os
from dotenv import load_dotenv
from frank.modules import TestMod, McStat
from frank import Frank
if __name__ == "__main__":
load_dotenv()
client = Frank([TestMod, McStat])
client.run(os.getenv('DISCORD_TOKEN'))

0
pytest.ini 100755 → 100644
View File

13
requirements-dev.txt 100644
View File

@ -0,0 +1,13 @@
jedi>=0.17.2,<1.0.0
flake8~=3.8.3
flake8-bugbear~=20.1.4
flake8-builtins~=1.5.3
flake8-commas~=2.0.0
flake8-comprehensions~=3.2.3
flake8-eradicate~=0.4.0
flake8-quotes~=3.2.0
flake8-variables-names~=0.0.3
setuptools~=49.6.0
pytest>=6.0.1,<7.0.0
pytest-asyncio>=0.14.0,<1.0.0
twine>=3.2.0,<4.0.0

8
requirements.txt
View File

@ -1,6 +1,2 @@
discord.py
pylint
jedi
python-dotenv
pyyaml
mcstatus
discord.py>=1.4.1,<2.0.0
PyYAML>=5.3.1,<6.0.0

28
setup.py 100755 → 100644
View File

@ -0,0 +1,28 @@
# =====IMPORTS=====
# Third-party imports
import setuptools
with open('requirements.txt', 'r') as reqs_file:
reqs = [line.strip() for line in reqs_file.readlines()]
setuptools.setup(
name='frank',
version='0.1.0',
author='Jef Roosens',
author_email='',
description='A modular tool for building Discord bots',
long_description='See https://gitlab.com/Chewing_Bever/frank for details.',
url='https://gitlab.com/Chewing_Bever/frank',
packages=setuptools.find_packages(exclude=('tests',)),
classifiers=[
'Development Status :: 3 - Alpha',
'Environment :: No Input/Output (Daemon)',
'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
'Operating System :: OS Independent',
'Programming Language :: Python :: 3.8',
],
python_requires='>=3.8',
install_requires=reqs,
setup_requires=['wheel'],
)

0
tests/__init__.py 100644
View File

25
tests/module_tester.py 100644
View File

@ -0,0 +1,25 @@
from frank import Module, command, default, daemon, regex_command
class ModuleTester(Module):
PREFIX = 'tester'
@regex_command('pat')
async def regex1(pregix, cmd, author, channel, mid):
pass
@regex_command('pat2')
async def regex2(pregix, cmd, author, channel, mid):
pass
@command('test')
async def test(cmd, author, channel, mid):
pass
@default()
async def test2(prefix, cmd, author, channel, mid):
pass
@daemon()
async def test_daemon(self):
pass

50
tests/test_module.py 100644
View File

@ -0,0 +1,50 @@
from .module_tester import ModuleTester
from frank import Default, Daemon, Command, RegexCommand
from frank.module.exceptions import InvalidCommand
import pytest
def test_property_types():
"""
Test wether the cached_property's return the expected value
"""
test_mod = ModuleTester(None)
assert isinstance(test_mod.default, Default)
assert hasattr(test_mod.default, 'help_str')
assert isinstance(test_mod.commands, list)
assert all((
isinstance(item, Command) for item in test_mod.commands
))
assert isinstance(test_mod.daemons, list)
assert all((
isinstance(item, Daemon) for item in test_mod.daemons
))
@pytest.mark.asyncio
async def test_invalid_command():
test_mod = ModuleTester(None)
with pytest.raises(InvalidCommand):
# None is just a placeholder here
await test_mod('aninvalidcommand', None, None, None)
def test_match():
test_mod = ModuleTester(None)
assert test_mod.match('tester')
assert not test_mod.match('testerrr')
def test_commands_order():
test_mod = ModuleTester(None)
types = [Command, RegexCommand, RegexCommand]
assert all((isinstance(cmd, obj_type)
for cmd, obj_type in zip(test_mod.commands, types)))