generated from PlexSheep/baserepo
Merge pull request 'idk why this isn't in master yet' (#94) from devel into master
cargo devel CI / cargo CI (push) Successful in 1m59s
Details
cargo devel CI / cargo CI (push) Successful in 1m59s
Details
Reviewed-on: #94
This commit is contained in:
commit
d48b87dcfe
23
Cargo.toml
23
Cargo.toml
|
|
@ -1,36 +1,28 @@
|
|||
[workspace]
|
||||
resolver = "2"
|
||||
members = [
|
||||
".",
|
||||
"members/libpt-core",
|
||||
"members/libpt-log",
|
||||
"members/libpt-py",
|
||||
]
|
||||
members = [".", "members/libpt-core", "members/libpt-log", "members/libpt-cli"]
|
||||
default-members = [".", "members/libpt-core"]
|
||||
|
||||
[workspace.package]
|
||||
publish = true
|
||||
version = "0.5.1"
|
||||
version = "0.6.0"
|
||||
edition = "2021"
|
||||
authors = ["Christoph J. Scherr <software@cscherr.de>"]
|
||||
license = "MIT"
|
||||
license = "GPL-3.0-or-later"
|
||||
description = "Personal multitool"
|
||||
readme = "README.md"
|
||||
homepage = "https://git.cscherr.de/PlexSheep/pt"
|
||||
repository = "https://git.cscherr.de/PlexSheep/pt"
|
||||
keywords = ["library"]
|
||||
categories = [
|
||||
"command-line-utilities",
|
||||
"development-tools",
|
||||
"development-tools::ffi",
|
||||
]
|
||||
categories = ["command-line-utilities", "development-tools"]
|
||||
|
||||
[workspace.dependencies]
|
||||
anyhow = "1.0.79"
|
||||
thiserror = "1.0.56"
|
||||
libpt-core = { version = "0.4.0", path = "members/libpt-core" }
|
||||
libpt-bintols = { version = "0.5.1", path = "members/libpt-bintols" }
|
||||
libpt-log = { version = "0.4.2", path = "members/libpt-log" }
|
||||
libpt-log = { version = "0.5.1", path = "members/libpt-log" }
|
||||
libpt-cli = { version = "0.1.2", path = "members/libpt-cli" }
|
||||
|
||||
[package]
|
||||
name = "libpt"
|
||||
|
|
@ -52,7 +44,7 @@ core = []
|
|||
full = ["default", "core", "log", "bintols"]
|
||||
log = ["dep:libpt-log"]
|
||||
bintols = ["dep:libpt-bintols", "log"]
|
||||
# py = ["dep:libpt-py"]
|
||||
cli = ["dep:libpt-cli", "core", "log"]
|
||||
|
||||
[lib]
|
||||
name = "libpt"
|
||||
|
|
@ -66,3 +58,4 @@ crate-type = [
|
|||
libpt-core = { workspace = true }
|
||||
libpt-bintols = { workspace = true, optional = true }
|
||||
libpt-log = { workspace = true, optional = true }
|
||||
libpt-cli = { workspace = true, optional = true }
|
||||
|
|
|
|||
688
LICENSE
688
LICENSE
|
|
@ -1,21 +1,675 @@
|
|||
MIT License
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (c) 2024 Christoph Johannes Scherr
|
||||
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.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
Preamble
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
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>.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,36 @@
|
|||
[package]
|
||||
name = "libpt-cli"
|
||||
publish.workspace = true
|
||||
version = "0.1.2"
|
||||
edition.workspace = true
|
||||
authors.workspace = true
|
||||
license.workspace = true
|
||||
description.workspace = true
|
||||
readme.workspace = true
|
||||
homepage.workspace = true
|
||||
repository.workspace = true
|
||||
keywords.workspace = true
|
||||
categories.workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples"]
|
||||
|
||||
[features]
|
||||
default = []
|
||||
log = ["dep:log"]
|
||||
|
||||
[dependencies]
|
||||
anyhow.workspace = true
|
||||
clap = { version = "4.5.7", features = ["derive"] }
|
||||
comfy-table = "7.1.1"
|
||||
console = "0.15.8"
|
||||
dialoguer = { version = "0.11.0", features = ["completion", "history"] }
|
||||
embed-doc-image = "0.1.4"
|
||||
exitcode = "1.1.2"
|
||||
human-panic = "2.0.0"
|
||||
indicatif = "0.17.8"
|
||||
libpt-log = { workspace = true, optional = false }
|
||||
log = { version = "0.4.21", optional = true }
|
||||
shlex = "1.3.0"
|
||||
strum = { version = "0.26.3", features = ["derive"] }
|
||||
thiserror.workspace = true
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 142 KiB |
|
|
@ -0,0 +1,38 @@
|
|||
use clap::Parser;
|
||||
use libpt_cli::args::VerbosityLevel;
|
||||
use libpt_cli::{clap, printing};
|
||||
use libpt_log::{debug, Logger};
|
||||
|
||||
/// This is the help
|
||||
///
|
||||
/// This is more help
|
||||
#[derive(Parser, Debug)]
|
||||
struct Cli {
|
||||
// already has documentation
|
||||
#[command(flatten)]
|
||||
verbosity: VerbosityLevel,
|
||||
|
||||
/// texts to be echoed
|
||||
#[arg(required = true)]
|
||||
text: Vec<String>,
|
||||
|
||||
/// try to be more machine readable
|
||||
#[arg(short, long)]
|
||||
machine: bool,
|
||||
}
|
||||
|
||||
fn main() {
|
||||
let cli = Cli::parse();
|
||||
let _logger = Logger::builder().set_level(cli.verbosity.level()).build();
|
||||
|
||||
debug!("logger initialized with level: {}", cli.verbosity.level());
|
||||
|
||||
if !cli.machine {
|
||||
let text = cli.text.join(" ");
|
||||
printing::blockprint(text, console::Color::Green);
|
||||
} else {
|
||||
for text in cli.text {
|
||||
println!("{text}")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,82 @@
|
|||
use console::style;
|
||||
use libpt_cli::repl::{DefaultRepl, Repl};
|
||||
use libpt_cli::{clap, printing, strum};
|
||||
use libpt_log::{debug, Logger};
|
||||
|
||||
use clap::Subcommand;
|
||||
use strum::EnumIter;
|
||||
|
||||
// this is where you define what data/commands/arguments the REPL accepts
|
||||
#[derive(Subcommand, Debug, EnumIter, Clone)]
|
||||
enum ReplCommand {
|
||||
/// wait for LEN seconds
|
||||
Wait {
|
||||
/// wait so long
|
||||
len: u64,
|
||||
},
|
||||
/// echo the given texts
|
||||
Echo {
|
||||
/// the text you want to print
|
||||
text: Vec<String>,
|
||||
/// print with a fancy border and colors
|
||||
#[arg(short, long)]
|
||||
fancy: bool,
|
||||
},
|
||||
/// hello world
|
||||
Hello,
|
||||
/// leave the repl
|
||||
Exit,
|
||||
}
|
||||
|
||||
fn main() -> anyhow::Result<()> {
|
||||
// You would normally make a proper cli interface with clap before entering the repl. This is
|
||||
// omitted here for brevity
|
||||
let _logger = Logger::builder().display_time(false).build();
|
||||
|
||||
// the compiler can infer that we want to use the ReplCommand enum.
|
||||
let mut repl = DefaultRepl::<ReplCommand>::default();
|
||||
|
||||
debug!("entering the repl");
|
||||
loop {
|
||||
// repl.step() should be at the start of your loop
|
||||
// It is here that the repl will get the user input, validate it, and so on
|
||||
match repl.step() {
|
||||
Ok(c) => c,
|
||||
Err(e) => {
|
||||
// if the user requested the help, print in blue, otherwise in red as it's just an
|
||||
// error
|
||||
if let libpt_cli::repl::error::Error::Parsing(e) = &e {
|
||||
if e.kind() == clap::error::ErrorKind::DisplayHelp {
|
||||
println!("{}", style(e).cyan());
|
||||
continue;
|
||||
}
|
||||
}
|
||||
println!("{}", style(e).red().bold());
|
||||
continue;
|
||||
}
|
||||
};
|
||||
|
||||
// now we can match our defined commands
|
||||
//
|
||||
// only None if the repl has not stepped yet
|
||||
match repl.command().to_owned().unwrap() {
|
||||
ReplCommand::Exit => break,
|
||||
ReplCommand::Wait { len } => {
|
||||
debug!("len: {len}");
|
||||
let spinner = indicatif::ProgressBar::new_spinner();
|
||||
spinner.enable_steady_tick(std::time::Duration::from_millis(100));
|
||||
std::thread::sleep(std::time::Duration::from_secs(len));
|
||||
spinner.finish();
|
||||
}
|
||||
ReplCommand::Hello => println!("Hello!"),
|
||||
ReplCommand::Echo { text, fancy } => {
|
||||
if !fancy {
|
||||
println!("{}", text.join(" "))
|
||||
} else {
|
||||
printing::blockprint(&text.join(" "), console::Color::Cyan)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
|
@ -0,0 +1,280 @@
|
|||
//! Utilities for parsing options and arguments on the start of a CLI application
|
||||
|
||||
use clap::Parser;
|
||||
use libpt_log::Level;
|
||||
#[cfg(feature = "log")]
|
||||
use log;
|
||||
|
||||
/// Custom help template for displaying command-line usage information
|
||||
///
|
||||
/// This template modifies the default template provided by Clap to include additional information
|
||||
/// and customize the layout of the help message.
|
||||
///
|
||||
/// Differences from the default template:
|
||||
/// - Includes the application version and author information at the end
|
||||
///
|
||||
/// Apply like this:
|
||||
/// ```
|
||||
/// # use libpt_cli::args::HELP_TEMPLATE;
|
||||
/// use clap::Parser;
|
||||
/// #[derive(Parser, Debug, Clone, PartialEq, Eq, Hash)]
|
||||
/// #[command(help_template = HELP_TEMPLATE, author, version)]
|
||||
/// pub struct MyArgs {
|
||||
/// /// show more details
|
||||
/// #[arg(short, long)]
|
||||
/// pub verbose: bool,
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// ## Example
|
||||
///
|
||||
/// Don't forget to set `authors` in your `Cargo.toml`!
|
||||
///
|
||||
/// ```bash
|
||||
/// $ cargo run -- -h
|
||||
/// about: short
|
||||
///
|
||||
/// Usage: aaa [OPTIONS]
|
||||
///
|
||||
/// Options:
|
||||
/// -v, --verbose show more details
|
||||
/// -h, --help Print help (see more with '--help')
|
||||
/// -V, --version Print version
|
||||
///
|
||||
/// aaa: 0.1.0
|
||||
/// Author: Christoph J. Scherr <software@cscherr.de>
|
||||
///
|
||||
/// ```
|
||||
pub const HELP_TEMPLATE: &str = r"{about-section}
|
||||
{usage-heading} {usage}
|
||||
|
||||
{all-args}{tab}
|
||||
|
||||
{name}: {version}
|
||||
Author: {author-with-newline}
|
||||
";
|
||||
|
||||
/// Transform -v and -q flags to some kind of loglevel
|
||||
///
|
||||
/// # Example
|
||||
///
|
||||
/// Include this into your [clap] derive struct like this:
|
||||
///
|
||||
/// ```
|
||||
/// use libpt_cli::args::VerbosityLevel;
|
||||
/// use clap::Parser;
|
||||
///
|
||||
/// #[derive(Parser, Debug)]
|
||||
/// pub struct Opts {
|
||||
/// #[command(flatten)]
|
||||
/// pub verbose: VerbosityLevel,
|
||||
/// #[arg(short, long)]
|
||||
/// pub mynum: usize,
|
||||
/// }
|
||||
///
|
||||
/// ```
|
||||
///
|
||||
/// Get the loglevel like this:
|
||||
///
|
||||
/// ```no_run
|
||||
/// # use libpt_cli::args::VerbosityLevel;
|
||||
/// use libpt_log::Level;
|
||||
/// # use clap::Parser;
|
||||
///
|
||||
/// # #[derive(Parser, Debug)]
|
||||
/// # pub struct Opts {
|
||||
/// # #[command(flatten)]
|
||||
/// # pub verbose: VerbosityLevel,
|
||||
/// # }
|
||||
///
|
||||
/// fn main() {
|
||||
/// let opts = Opts::parse();
|
||||
///
|
||||
/// // Level might be None if the user wants no output at all.
|
||||
/// // for the 'tracing' level:
|
||||
/// let level: Level = opts.verbose.level();
|
||||
/// }
|
||||
/// ```
|
||||
#[derive(Parser, Clone, PartialEq, Eq, Hash)]
|
||||
pub struct VerbosityLevel {
|
||||
/// make the output more verbose
|
||||
#[arg(
|
||||
long,
|
||||
short = 'v',
|
||||
action = clap::ArgAction::Count, // NOTE: this forces u8 type for some reason
|
||||
global = true,
|
||||
// help = L::verbose_help(),
|
||||
// long_help = L::verbose_long_help(),
|
||||
)]
|
||||
verbose: u8,
|
||||
|
||||
/// make the output less verbose
|
||||
///
|
||||
/// ( -qqq for completely quiet)
|
||||
#[arg(
|
||||
long,
|
||||
short = 'q',
|
||||
action = clap::ArgAction::Count,
|
||||
global = true,
|
||||
conflicts_with = "verbose",
|
||||
)]
|
||||
quiet: u8,
|
||||
}
|
||||
|
||||
impl VerbosityLevel {
|
||||
/// true only if no verbose and no quiet was set (user is using defaults)
|
||||
#[inline]
|
||||
#[must_use]
|
||||
#[allow(clippy::missing_const_for_fn)] // the values of self can change
|
||||
pub fn changed(&self) -> bool {
|
||||
self.verbose != 0 || self.quiet != 0
|
||||
}
|
||||
#[inline]
|
||||
#[must_use]
|
||||
fn value(&self) -> u8 {
|
||||
Self::level_value(Level::INFO)
|
||||
.saturating_sub((self.quiet).min(10))
|
||||
.saturating_add((self.verbose).min(10))
|
||||
}
|
||||
|
||||
/// get the [Level] for that [`VerbosityLevel`]
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use libpt_log::Level; // reexport: tracing
|
||||
/// use libpt_cli::args::VerbosityLevel;
|
||||
///
|
||||
/// let verbosity_level = VerbosityLevel::INFO;
|
||||
/// assert_eq!(verbosity_level.level(), Level::INFO);
|
||||
/// ```
|
||||
#[inline]
|
||||
#[must_use]
|
||||
pub fn level(&self) -> Level {
|
||||
let v = self.value();
|
||||
match v {
|
||||
0 => Level::ERROR,
|
||||
1 => Level::WARN,
|
||||
2 => Level::INFO,
|
||||
3 => Level::DEBUG,
|
||||
4 => Level::TRACE,
|
||||
_ => {
|
||||
if v > 4 {
|
||||
Level::TRACE
|
||||
} else {
|
||||
/* v < 0 */
|
||||
Level::ERROR
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// get the [`log::Level`] for that `VerbosityLevel`
|
||||
///
|
||||
/// This is the method for the [log] crate, which I use less often.
|
||||
///
|
||||
/// [None] means that absolutely no output is wanted (completely quiet)
|
||||
#[inline]
|
||||
#[must_use]
|
||||
#[cfg(feature = "log")]
|
||||
pub fn level_for_log_crate(&self) -> log::Level {
|
||||
match self.level() {
|
||||
Level::TRACE => log::Level::Trace,
|
||||
Level::DEBUG => log::Level::Debug,
|
||||
Level::INFO => log::Level::Info,
|
||||
Level::WARN => log::Level::Warn,
|
||||
Level::ERROR => log::Level::Error,
|
||||
}
|
||||
}
|
||||
|
||||
#[inline]
|
||||
#[must_use]
|
||||
const fn level_value(level: Level) -> u8 {
|
||||
match level {
|
||||
Level::TRACE => 4,
|
||||
Level::DEBUG => 3,
|
||||
Level::INFO => 2,
|
||||
Level::WARN => 1,
|
||||
Level::ERROR => 0,
|
||||
}
|
||||
}
|
||||
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use libpt_log::Level; // reexport: tracing
|
||||
/// use libpt_cli::args::VerbosityLevel;
|
||||
///
|
||||
/// let verbosity_level = VerbosityLevel::TRACE;
|
||||
/// assert_eq!(verbosity_level.level(), Level::TRACE);
|
||||
/// ```
|
||||
pub const TRACE: Self = Self {
|
||||
verbose: 2,
|
||||
quiet: 0,
|
||||
};
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use libpt_log::Level; // reexport: tracing
|
||||
/// use libpt_cli::args::VerbosityLevel;
|
||||
///
|
||||
/// let verbosity_level = VerbosityLevel::DEBUG;
|
||||
/// assert_eq!(verbosity_level.level(), Level::DEBUG);
|
||||
/// ```
|
||||
pub const DEBUG: Self = Self {
|
||||
verbose: 1,
|
||||
quiet: 0,
|
||||
};
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use libpt_log::Level; // reexport: tracing
|
||||
/// use libpt_cli::args::VerbosityLevel;
|
||||
///
|
||||
/// let verbosity_level = VerbosityLevel::INFO;
|
||||
/// assert_eq!(verbosity_level.level(), Level::INFO);
|
||||
/// ```
|
||||
pub const INFO: Self = Self {
|
||||
verbose: 0,
|
||||
quiet: 0,
|
||||
};
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use libpt_log::Level; // reexport: tracing
|
||||
/// use libpt_cli::args::VerbosityLevel;
|
||||
///
|
||||
/// let verbosity_level = VerbosityLevel::WARN;
|
||||
/// assert_eq!(verbosity_level.level(), Level::WARN);
|
||||
/// ```
|
||||
pub const WARN: Self = Self {
|
||||
verbose: 0,
|
||||
quiet: 1,
|
||||
};
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use libpt_log::Level; // reexport: tracing
|
||||
/// use libpt_cli::args::VerbosityLevel;
|
||||
///
|
||||
/// let verbosity_level = VerbosityLevel::ERROR;
|
||||
/// assert_eq!(verbosity_level.level(), Level::ERROR);
|
||||
/// ```
|
||||
pub const ERROR: Self = Self {
|
||||
verbose: 0,
|
||||
quiet: 2,
|
||||
};
|
||||
}
|
||||
|
||||
impl std::fmt::Debug for VerbosityLevel {
|
||||
#[inline]
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
write!(f, "{:?}", self.level())
|
||||
}
|
||||
}
|
||||
|
||||
impl Default for VerbosityLevel {
|
||||
fn default() -> Self {
|
||||
Self::INFO
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
//! This module bundles a lot of good CLI tools, and adds some of it's own, to make development of
|
||||
//! CLI apps easier and more ergonomic.
|
||||
#![warn(clippy::pedantic, clippy::style, clippy::nursery)]
|
||||
pub mod args;
|
||||
pub mod printing;
|
||||
pub mod repl;
|
||||
|
||||
pub use clap;
|
||||
pub use comfy_table;
|
||||
pub use console;
|
||||
pub use dialoguer;
|
||||
pub use exitcode;
|
||||
pub use human_panic;
|
||||
pub use indicatif;
|
||||
pub use shlex;
|
||||
pub use strum;
|
||||
|
|
@ -0,0 +1,145 @@
|
|||
//! Utilities for formatting, bordering, aligning and printing text content
|
||||
//!
|
||||
//! This module provides functions for formatting content with borders and colors, printing them to the console.
|
||||
//! The functions in this module are designed to simplify the process of creating visually appealing
|
||||
//! output for CLI applications.
|
||||
//!
|
||||
//! Note that most of the utilities in this module are focused on communication with humans, not
|
||||
//! with machines. Consider evaluating [`std::io::IsTerminal`] before using colorful, dynamic and bordered
|
||||
//! printing. If you are talking to a machine, it might be useful to not add extra space, add a
|
||||
//! newline per output or even output JSON. An example that does this well is `ls`:
|
||||
//!
|
||||
//! ```bash
|
||||
//! $ ls
|
||||
//! Cargo.lock Cargo.toml data LICENSE members README.md scripts src target
|
||||
//! ```
|
||||
//!
|
||||
//! ```bash
|
||||
//! $ ls | cat
|
||||
//! Cargo.lock
|
||||
//! Cargo.toml
|
||||
//! data
|
||||
//! LICENSE
|
||||
//! members
|
||||
//! README.md
|
||||
//! scripts
|
||||
//! src
|
||||
//! target
|
||||
//! ```
|
||||
//!
|
||||
//! See the [CLI Rustbook](https://rust-cli.github.io/book/in-depth/machine-communication.html) for
|
||||
//! more information on the topic.
|
||||
|
||||
use comfy_table::presets;
|
||||
use comfy_table::{CellAlignment, ContentArrangement, Table};
|
||||
use console::{style, Color};
|
||||
|
||||
/// Prints content with a simple border around it
|
||||
///
|
||||
/// This function is a convenience wrapper around [blockfmt] and [println]. It automatically
|
||||
/// formats the content with a border using the specified color and then prints it to the console.
|
||||
///
|
||||
/// # Example
|
||||
///
|
||||
/// ```
|
||||
/// use libpt_cli::console::Color;
|
||||
/// use libpt_cli::printing::blockprint;
|
||||
/// # fn main() {
|
||||
/// blockprint("Hello world!", Color::Blue);
|
||||
/// # }
|
||||
/// ```
|
||||
#[inline]
|
||||
#[allow(clippy::needless_pass_by_value)] // we just take an impl, using a &impl is much less ergonomic
|
||||
pub fn blockprint(content: impl ToString, color: Color) {
|
||||
println!("{}", blockfmt(content, color));
|
||||
}
|
||||
|
||||
/// Formats content with a simple border around it
|
||||
///
|
||||
/// This function is a convenience wrapper around [`blockfmt_advanced`] with preset values for
|
||||
/// border style, content arrangement, and cell alignment. It automatically formats the content
|
||||
/// with a border as large as possible and centers the content. The resulting cell is colored in
|
||||
/// the specified color.
|
||||
///
|
||||
/// # Example
|
||||
///
|
||||
/// ```
|
||||
/// use libpt_cli::console::Color;
|
||||
/// use libpt_cli::printing::blockfmt;
|
||||
/// # fn main() {
|
||||
/// let formatted_content = blockfmt("Hello world!", Color::Blue);
|
||||
/// println!("{}", formatted_content);
|
||||
/// # }
|
||||
/// ```
|
||||
#[inline]
|
||||
#[allow(clippy::needless_pass_by_value)] // we just take an impl, using a &impl is much less ergonomic
|
||||
pub fn blockfmt(content: impl ToString, color: Color) -> String {
|
||||
blockfmt_advanced(
|
||||
content,
|
||||
Some(color),
|
||||
presets::UTF8_BORDERS_ONLY,
|
||||
ContentArrangement::DynamicFullWidth,
|
||||
CellAlignment::Center,
|
||||
)
|
||||
}
|
||||
|
||||
/// Formats content with a border around it
|
||||
///
|
||||
/// Unless you are looking for something specific, use [blockfmt] or [blockprint].
|
||||
///
|
||||
/// The border can be created using box-drawing characters, and the content is formatted
|
||||
/// within the border. The function allows customization of the border's color, preset,
|
||||
/// content arrangement, and cell alignment.
|
||||
///
|
||||
/// # Example
|
||||
/// ```
|
||||
/// use libpt_cli::comfy_table::{presets, CellAlignment, ContentArrangement};
|
||||
/// use libpt_cli::console::Color;
|
||||
/// use libpt_cli::printing::blockfmt_advanced;
|
||||
/// # fn main() {
|
||||
/// println!(
|
||||
/// "{}",
|
||||
/// blockfmt_advanced(
|
||||
/// "Hello world!",
|
||||
/// Some(Color::Blue),
|
||||
/// presets::UTF8_FULL,
|
||||
/// ContentArrangement::DynamicFullWidth,
|
||||
/// CellAlignment::Center
|
||||
/// )
|
||||
/// );
|
||||
/// # }
|
||||
/// ```
|
||||
/// ```text
|
||||
/// ┌────────────────────────────────────────────────────────────────────────────────────────┐
|
||||
/// │ Hello world! │
|
||||
/// └────────────────────────────────────────────────────────────────────────────────────────┘
|
||||
/// ```
|
||||
///
|
||||
/// # Parameters
|
||||
///
|
||||
/// - `content`: The content to be formatted within the border
|
||||
/// - `color`: The color of the border and text
|
||||
/// - `preset`: The preset style for the border
|
||||
/// - `arrangement`: The arrangement of the the border (e.g., stretch to sides, wrap around )
|
||||
/// - `alignment`: The alignment of the content within the cells (e.g., left, center, right)
|
||||
#[allow(clippy::missing_panics_doc)] // we add a row then unwrap it, no panic should be possible
|
||||
#[allow(clippy::needless_pass_by_value)] // we just take an impl, using a &impl is much less ergonomic
|
||||
pub fn blockfmt_advanced(
|
||||
content: impl ToString,
|
||||
color: Option<Color>,
|
||||
preset: &str,
|
||||
arrangement: ContentArrangement,
|
||||
alignment: CellAlignment,
|
||||
) -> String {
|
||||
let mut table = Table::new();
|
||||
table
|
||||
.load_preset(preset)
|
||||
.set_content_arrangement(arrangement)
|
||||
.add_row(vec![content.to_string()]);
|
||||
table.column_mut(0).unwrap().set_cell_alignment(alignment);
|
||||
|
||||
match color {
|
||||
Some(c) => format!("{}", style(table).fg(c)),
|
||||
None => table.to_string(),
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,217 @@
|
|||
//! This module implements a default repl that fullfills the [Repl] trait
|
||||
//!
|
||||
//! You can implement your own [Repl] if you want.
|
||||
|
||||
use std::fmt::Debug;
|
||||
|
||||
use super::Repl;
|
||||
|
||||
use embed_doc_image::embed_doc_image;
|
||||
|
||||
/// [clap] help template with only usage and commands/options
|
||||
pub const REPL_HELP_TEMPLATE: &str = r"{usage-heading} {usage}
|
||||
|
||||
{all-args}{tab}
|
||||
";
|
||||
|
||||
use clap::{Parser, Subcommand};
|
||||
use dialoguer::{BasicHistory, Completion};
|
||||
use libpt_log::trace;
|
||||
|
||||
#[allow(clippy::needless_doctest_main)] // It makes the example look better
|
||||
/// Default implementation for a REPL
|
||||
///
|
||||
/// Note that you need to define the commands by yourself with a Subcommands enum.
|
||||
///
|
||||
/// # Example
|
||||
///
|
||||
/// ```no_run
|
||||
/// use libpt_cli::repl::{DefaultRepl, Repl};
|
||||
/// use libpt_cli::clap::Subcommand;
|
||||
/// use libpt_cli::strum::EnumIter;
|
||||
///
|
||||
/// #[derive(Subcommand, Debug, EnumIter, Clone)]
|
||||
/// enum ReplCommand {
|
||||
/// /// hello world
|
||||
/// Hello,
|
||||
/// /// leave the repl
|
||||
/// Exit,
|
||||
/// }
|
||||
///
|
||||
/// fn main() {
|
||||
/// let mut repl = DefaultRepl::<ReplCommand>::default();
|
||||
/// loop {
|
||||
/// repl.step().unwrap();
|
||||
/// match repl.command().to_owned().unwrap() {
|
||||
/// ReplCommand::Hello => println!("Hello"),
|
||||
/// ReplCommand::Exit => break,
|
||||
/// _ => (),
|
||||
/// }
|
||||
/// }
|
||||
/// }
|
||||
/// ```
|
||||
/// **Screenshot**
|
||||
///
|
||||
/// ![Screenshot of an example program with a REPL][repl_screenshot]
|
||||
#[embed_doc_image("repl_screenshot", "data/media/repl.png")]
|
||||
#[derive(Parser)]
|
||||
#[command(multicall = true, help_template = REPL_HELP_TEMPLATE)]
|
||||
#[allow(clippy::module_name_repetitions)] // we can't just name it `Default`, that's part of std
|
||||
pub struct DefaultRepl<C>
|
||||
where
|
||||
C: Debug + Subcommand + strum::IntoEnumIterator,
|
||||
{
|
||||
/// the command you want to execute, along with its arguments
|
||||
#[command(subcommand)]
|
||||
command: Option<C>,
|
||||
|
||||
// the following fields are not to be parsed from a command, but used for the internal workings
|
||||
// of the repl
|
||||
#[clap(skip)]
|
||||
buf: String,
|
||||
#[clap(skip)]
|
||||
buf_preparsed: Vec<String>,
|
||||
#[clap(skip)]
|
||||
completion: DefaultReplCompletion<C>,
|
||||
#[clap(skip)]
|
||||
history: BasicHistory,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Copy, Hash, Eq, PartialEq, PartialOrd, Ord)]
|
||||
struct DefaultReplCompletion<C>
|
||||
where
|
||||
C: Debug + Subcommand + strum::IntoEnumIterator,
|
||||
{
|
||||
commands: std::marker::PhantomData<C>,
|
||||
}
|
||||
|
||||
impl<C> Repl<C> for DefaultRepl<C>
|
||||
where
|
||||
C: Debug + Subcommand + strum::IntoEnumIterator,
|
||||
{
|
||||
fn new() -> Self {
|
||||
Self {
|
||||
command: None,
|
||||
buf_preparsed: Vec::new(),
|
||||
buf: String::new(),
|
||||
history: BasicHistory::new(),
|
||||
completion: DefaultReplCompletion::new(),
|
||||
}
|
||||
}
|
||||
fn command(&self) -> &Option<C> {
|
||||
&self.command
|
||||
}
|
||||
fn step(&mut self) -> Result<(), super::error::Error> {
|
||||
self.buf.clear();
|
||||
|
||||
// NOTE: display::Input requires some kind of lifetime that would be a bother to store in
|
||||
// our struct. It's documentation also uses it in place, so it should be fine to do it like
|
||||
// this.
|
||||
//
|
||||
// NOTE: It would be nice if we could use the Validator mechanism of dialoguer, but
|
||||
// unfortunately we can only process our input after we've preparsed it and we need an
|
||||
// actual output. If we could set a status after the Input is over that would be amazing,
|
||||
// but that is currently not supported by dialoguer.
|
||||
// Therefore, every prompt will show as success regardless.
|
||||
self.buf = dialoguer::Input::with_theme(&dialoguer::theme::ColorfulTheme::default())
|
||||
.completion_with(&self.completion)
|
||||
.history_with(&mut self.history)
|
||||
.interact_text()?;
|
||||
|
||||
self.buf_preparsed = Vec::new();
|
||||
self.buf_preparsed
|
||||
.extend(shlex::split(&self.buf).unwrap_or_default());
|
||||
|
||||
trace!("read input: {:?}", self.buf_preparsed);
|
||||
trace!("repl after step: {:#?}", self);
|
||||
|
||||
// HACK: find a way to not allocate a new struct for this
|
||||
let cmds = Self::try_parse_from(&self.buf_preparsed)?;
|
||||
self.command = cmds.command;
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
impl<C> Default for DefaultRepl<C>
|
||||
where
|
||||
C: Debug + Subcommand + strum::IntoEnumIterator,
|
||||
{
|
||||
fn default() -> Self {
|
||||
Self::new()
|
||||
}
|
||||
}
|
||||
|
||||
impl<C> Debug for DefaultRepl<C>
|
||||
where
|
||||
C: Debug + Subcommand + strum::IntoEnumIterator,
|
||||
{
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
f.debug_struct("DefaultRepl")
|
||||
.field("command", &self.command)
|
||||
.field("buf", &self.buf)
|
||||
.field("buf_preparsed", &self.buf_preparsed)
|
||||
.field("completion", &self.completion)
|
||||
.field("history", &"(no debug)")
|
||||
.finish()
|
||||
}
|
||||
}
|
||||
|
||||
impl<C> DefaultReplCompletion<C>
|
||||
where
|
||||
C: Debug + Subcommand + strum::IntoEnumIterator,
|
||||
{
|
||||
/// Make a new [`DefaultReplCompletion`] for the type `C`
|
||||
pub const fn new() -> Self {
|
||||
Self {
|
||||
commands: std::marker::PhantomData::<C>,
|
||||
}
|
||||
}
|
||||
fn commands() -> Vec<String> {
|
||||
let mut buf = Vec::new();
|
||||
// every crate has the help command, but it is not part of the enum
|
||||
buf.push("help".to_string());
|
||||
for c in C::iter() {
|
||||
// HACK: this is a horrible way to do this
|
||||
// I just need the names of the commands
|
||||
buf.push(
|
||||
format!("{c:?}")
|
||||
.split_whitespace()
|
||||
.map(str::to_lowercase)
|
||||
.next()
|
||||
.unwrap()
|
||||
.to_string(),
|
||||
);
|
||||
}
|
||||
trace!("commands: {buf:?}");
|
||||
buf
|
||||
}
|
||||
}
|
||||
|
||||
impl<C> Default for DefaultReplCompletion<C>
|
||||
where
|
||||
C: Debug + Subcommand + strum::IntoEnumIterator,
|
||||
{
|
||||
fn default() -> Self {
|
||||
Self::new()
|
||||
}
|
||||
}
|
||||
|
||||
impl<C> Completion for DefaultReplCompletion<C>
|
||||
where
|
||||
C: Debug + Subcommand + strum::IntoEnumIterator,
|
||||
{
|
||||
/// Simple completion implementation based on substring
|
||||
fn get(&self, input: &str) -> Option<String> {
|
||||
let matches = Self::commands()
|
||||
.into_iter()
|
||||
.filter(|option| option.starts_with(input))
|
||||
.collect::<Vec<_>>();
|
||||
|
||||
trace!("\nmatches: {matches:#?}");
|
||||
if matches.len() == 1 {
|
||||
Some(matches[0].to_string())
|
||||
} else {
|
||||
None
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
//! Errors for the Repl module
|
||||
|
||||
use thiserror::Error;
|
||||
|
||||
#[derive(Error, Debug)]
|
||||
pub enum Error {
|
||||
#[error(transparent)]
|
||||
Parsing(#[from] clap::Error),
|
||||
#[error(transparent)]
|
||||
Input(#[from] dialoguer::Error),
|
||||
#[error(transparent)]
|
||||
Other(#[from] anyhow::Error),
|
||||
}
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
//! Create easy and well defined REPLs
|
||||
//!
|
||||
//! A REPL is a [Read-Eval-Print-Loop](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop).
|
||||
//! Well known examples for REPLs are shells (like bash).
|
||||
//!
|
||||
//! This module offers a convenient way to create a well-defined REPL without a lot of complicated
|
||||
//! code and with a visually pleasing aesthetic. An example REPL implementation can be found in the
|
||||
//! examples.
|
||||
//!
|
||||
//! The basic idea is that the user defines the commands with an enum and uses [claps](clap)
|
||||
//! `#[derive(Subcommand)]`. A loop is then used to read from the stdin into a buffer, that buffer
|
||||
//! is put to [clap] for parsing, similar to how [clap] would parse commandline arguments.
|
||||
|
||||
use std::fmt::Debug;
|
||||
|
||||
pub mod error;
|
||||
use error::Error;
|
||||
mod default;
|
||||
pub use default::*;
|
||||
|
||||
use clap::{Parser, Subcommand};
|
||||
|
||||
/// Common Trait for repl objects
|
||||
///
|
||||
/// Unless you want to implement custom features (not just commands), just use [`DefaultRepl`].
|
||||
pub trait Repl<C>: Parser + Debug
|
||||
where
|
||||
C: Debug + Subcommand + strum::IntoEnumIterator,
|
||||
{
|
||||
/// create a new repl
|
||||
fn new() -> Self;
|
||||
/// get the command that was parsed from user input
|
||||
///
|
||||
/// Will only be [None] if the repl has not had [step](Repl::step) executed yet.
|
||||
fn command(&self) -> &Option<C>;
|
||||
/// advance the repl to the next iteration of the main loop
|
||||
///
|
||||
/// This should be used at the start of your loop.
|
||||
///
|
||||
/// Note that the help menu is an Error: [`clap::error::ErrorKind::DisplayHelp`]
|
||||
///
|
||||
/// # Errors
|
||||
///
|
||||
/// * [`Error::Input`] – [dialoguer] User Input had some kind of I/O Error
|
||||
/// * [`Error::Parsing`] – [clap] could not parse the user input, or user requested help
|
||||
/// * [`Error::Other`] – Any other error with [anyhow], [`DefaultRepl`] does not use this but custom implementations might
|
||||
fn step(&mut self) -> Result<(), Error>;
|
||||
}
|
||||
|
|
@ -8,5 +8,3 @@
|
|||
|
||||
/// macros to make things faster in your code
|
||||
pub mod macros;
|
||||
/// some general use printing to stdout tools
|
||||
pub mod printing;
|
||||
|
|
|
|||
|
|
@ -1,11 +0,0 @@
|
|||
//! # tools that make printing stuff better
|
||||
|
||||
/// Quickly get a one line visual divider
|
||||
pub fn divider() -> String {
|
||||
format!("{:=^80}", "=")
|
||||
}
|
||||
|
||||
/// Quickly print a one line visual divider
|
||||
pub fn print_divider() {
|
||||
println!("{:=^80}", "=")
|
||||
}
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
[package]
|
||||
name = "libpt-log"
|
||||
publish.workspace = true
|
||||
version = "0.4.2"
|
||||
version = "0.5.1"
|
||||
edition.workspace = true
|
||||
authors.workspace = true
|
||||
license.workspace = true
|
||||
|
|
|
|||
|
|
@ -0,0 +1,11 @@
|
|||
use libpt_log::Logger;
|
||||
use tracing::info;
|
||||
|
||||
fn main() {
|
||||
let _logger = Logger::builder()
|
||||
.log_to_file(true)
|
||||
.log_dir("/tmp/llll".into())
|
||||
.build()
|
||||
.unwrap();
|
||||
info!("foo bar qux");
|
||||
}
|
||||
|
|
@ -6,13 +6,16 @@
|
|||
//! For the library version, only the basic [`tracing`] is used, so that it is possible for
|
||||
//! the end user to use the [`tracing`] frontend they desire.
|
||||
//!
|
||||
//! I did however decide to create a [`Logger`] struct. This struct is mainly intended to be used
|
||||
//! with the python module of [`pt`](../libpt/index.html), but is still just as usable in other contexts.
|
||||
//! I did decide to create a [`Logger`] struct. This struct is mainly intended to be used with the
|
||||
//! python module of [`pt`](../libpt/index.html), but is still just as usable in other contexts.
|
||||
//! You can use this struct when use of the macros is not possible, but the macros should generally
|
||||
//! be preferred.
|
||||
//!
|
||||
//! ## Technologies used for logging:
|
||||
//! - [`tracing`]: base logging crate
|
||||
//! - [`tracing_appender`]: Used to log to files
|
||||
//! - [`tracing_subscriber`]: Used to do actual logging, formatting, to stdout
|
||||
#![warn(clippy::pedantic, clippy::style, clippy::nursery)]
|
||||
|
||||
use std::{
|
||||
fmt,
|
||||
|
|
@ -21,10 +24,14 @@ use std::{
|
|||
};
|
||||
|
||||
pub mod error;
|
||||
use error::*;
|
||||
use error::Error;
|
||||
|
||||
/// This is the magic dependency where the cool stuff happens
|
||||
///
|
||||
/// I'm just repackaging it a little to make it more ergonomic
|
||||
pub use tracing;
|
||||
pub use tracing::{debug, error, info, trace, warn, Level};
|
||||
use tracing_appender::{self, non_blocking::NonBlocking};
|
||||
use tracing_appender::{self};
|
||||
use tracing_subscriber::fmt::{format::FmtSpan, time};
|
||||
|
||||
use anyhow::{bail, Result};
|
||||
|
|
@ -55,6 +62,8 @@ static INITIALIZED: AtomicBool = AtomicBool::new(false);
|
|||
///
|
||||
/// ```
|
||||
#[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
|
||||
#[allow(clippy::struct_excessive_bools)] // it's just true/false values, not states, and I don't
|
||||
// need to reinvent the wheel
|
||||
pub struct LoggerBuilder {
|
||||
/// create and log to logfiles
|
||||
log_to_file: bool,
|
||||
|
|
@ -135,11 +144,11 @@ impl LoggerBuilder {
|
|||
.with_line_number(self.display_line_number)
|
||||
.with_thread_names(self.display_thread_names)
|
||||
.with_span_events(FmtSpan::FULL);
|
||||
// HACK: somehow find a better solution for this
|
||||
// I know this is hacky, but I couldn't get it any other way. I couldn't even find a
|
||||
// project that could do it any other way. You can't apply one after another, because the
|
||||
// type is changed every time. When using `Box<dyn Whatever>`, some methods complain about
|
||||
// not being in trait bounds.
|
||||
// TODO: somehow find a better solution for this
|
||||
match (self.log_to_file, self.show_time, self.pretty, self.uptime) {
|
||||
(true, true, true, true) => {
|
||||
let subscriber = subscriber
|
||||
|
|
@ -178,9 +187,10 @@ impl LoggerBuilder {
|
|||
tracing::subscriber::set_global_default(subscriber)?;
|
||||
}
|
||||
(true, false, false, _) => {
|
||||
let file_appender = tracing_appender::rolling::daily(self.log_dir.clone(), "log");
|
||||
let (file_writer, _guard) = tracing_appender::non_blocking(file_appender);
|
||||
let subscriber = subscriber.with_writer(file_writer).without_time().finish();
|
||||
let subscriber = subscriber
|
||||
.with_writer(new_file_appender(self.log_dir))
|
||||
.without_time()
|
||||
.finish();
|
||||
tracing::subscriber::set_global_default(subscriber)?;
|
||||
}
|
||||
(false, true, true, true) => {
|
||||
|
|
@ -213,16 +223,22 @@ impl LoggerBuilder {
|
|||
}
|
||||
|
||||
/// enable or disable logging to and creating of logfiles
|
||||
pub fn log_to_file(mut self, log_to_file: bool) -> Self {
|
||||
///
|
||||
/// If you want to log to a file, don't forget to set [`Self::log_dir`]!
|
||||
///
|
||||
/// Default: false
|
||||
#[must_use]
|
||||
pub const fn log_to_file(mut self, log_to_file: bool) -> Self {
|
||||
self.log_to_file = log_to_file;
|
||||
self
|
||||
}
|
||||
|
||||
/// set a directory where logfiles would be created in
|
||||
///
|
||||
/// Enable or disable creation and logging to logfiles with [log_to_file](Self::log_to_file).
|
||||
/// Enable or disable creation and logging to logfiles with [`log_to_file`](Self::log_to_file).
|
||||
///
|
||||
/// The default logdir is [DEFAULT_LOG_DIR].
|
||||
/// Default: [`DEFAULT_LOG_DIR`] (/dev/null)
|
||||
#[must_use]
|
||||
pub fn log_dir(mut self, log_dir: PathBuf) -> Self {
|
||||
self.log_dir = log_dir;
|
||||
self
|
||||
|
|
@ -234,68 +250,101 @@ impl LoggerBuilder {
|
|||
/// are displayed by a program that does not interpret them.
|
||||
///
|
||||
/// Keeping ANSI control sequences enabled has the disadvantage of added colors for the logs.
|
||||
pub fn ansi(mut self, ansi: bool) -> Self {
|
||||
///
|
||||
/// Default: true
|
||||
#[must_use]
|
||||
pub const fn ansi(mut self, ansi: bool) -> Self {
|
||||
self.ansi = ansi;
|
||||
self
|
||||
}
|
||||
|
||||
/// when making a log, display the source file in which a log was crated in
|
||||
pub fn display_filename(mut self, display_filename: bool) -> Self {
|
||||
///
|
||||
/// Default: false
|
||||
#[must_use]
|
||||
pub const fn display_filename(mut self, display_filename: bool) -> Self {
|
||||
self.display_filename = display_filename;
|
||||
self
|
||||
}
|
||||
|
||||
/// when making a log, display the time of the message
|
||||
///
|
||||
/// Default: true
|
||||
#[must_use]
|
||||
pub const fn display_time(mut self, show_time: bool) -> Self {
|
||||
self.show_time = show_time;
|
||||
self
|
||||
}
|
||||
|
||||
/// when making a log, display the log level of the message
|
||||
pub fn display_level(mut self, display_level: bool) -> Self {
|
||||
///
|
||||
/// Default: true
|
||||
#[must_use]
|
||||
pub const fn display_level(mut self, display_level: bool) -> Self {
|
||||
self.display_level = display_level;
|
||||
self
|
||||
}
|
||||
|
||||
/// show target context
|
||||
pub fn display_target(mut self, display_target: bool) -> Self {
|
||||
///
|
||||
/// Default: false
|
||||
#[must_use]
|
||||
pub const fn display_target(mut self, display_target: bool) -> Self {
|
||||
self.display_target = display_target;
|
||||
self
|
||||
}
|
||||
|
||||
/// set the maximum verbosity level.
|
||||
pub fn max_level(mut self, max_level: Level) -> Self {
|
||||
self.max_level = max_level;
|
||||
self
|
||||
}
|
||||
|
||||
/// show the id of the thread that created this message
|
||||
pub fn display_thread_ids(mut self, display_thread_ids: bool) -> Self {
|
||||
///
|
||||
/// Default: false
|
||||
#[must_use]
|
||||
pub const fn display_thread_ids(mut self, display_thread_ids: bool) -> Self {
|
||||
self.display_thread_ids = display_thread_ids;
|
||||
self
|
||||
}
|
||||
|
||||
/// show the name of the thread that created this message
|
||||
pub fn display_thread_names(mut self, display_thread_names: bool) -> Self {
|
||||
///
|
||||
/// Default: false
|
||||
#[must_use]
|
||||
pub const fn display_thread_names(mut self, display_thread_names: bool) -> Self {
|
||||
self.display_thread_names = display_thread_names;
|
||||
self
|
||||
}
|
||||
|
||||
/// show which line in the source file produces a log
|
||||
pub fn display_line_number(mut self, display_line_number: bool) -> Self {
|
||||
///
|
||||
/// Default: false
|
||||
#[must_use]
|
||||
pub const fn display_line_number(mut self, display_line_number: bool) -> Self {
|
||||
self.display_line_number = display_line_number;
|
||||
self
|
||||
}
|
||||
|
||||
/// splits a log over multiple lines, looks like a python traceback
|
||||
pub fn pretty(mut self, pretty: bool) -> Self {
|
||||
///
|
||||
/// Default: false
|
||||
#[must_use]
|
||||
pub const fn pretty(mut self, pretty: bool) -> Self {
|
||||
self.pretty = pretty;
|
||||
self
|
||||
}
|
||||
|
||||
/// show a timestamp describing when the log was created
|
||||
pub fn show_time(mut self, show_time: bool) -> Self {
|
||||
self.show_time = show_time;
|
||||
/// show timestamps as uptime (duration since the logger was initialized)
|
||||
///
|
||||
/// Default: false
|
||||
#[must_use]
|
||||
pub const fn uptime(mut self, uptime: bool) -> Self {
|
||||
self.uptime = uptime;
|
||||
self
|
||||
}
|
||||
|
||||
/// show timestamps as uptime (duration since the logger was initialized)
|
||||
pub fn uptime(mut self, uptime: bool) -> Self {
|
||||
self.uptime = uptime;
|
||||
/// set the lowest loglevel to be displayed
|
||||
///
|
||||
/// Default: [`Level::INFO`]
|
||||
#[must_use]
|
||||
pub const fn set_level(mut self, max_level: Level) -> Self {
|
||||
self.max_level = max_level;
|
||||
self
|
||||
}
|
||||
}
|
||||
|
|
@ -332,19 +381,23 @@ impl Default for LoggerBuilder {
|
|||
///
|
||||
/// ## Levels
|
||||
///
|
||||
/// TODO: add levels desc and ascii art
|
||||
/// * [ERROR](Level::ERROR) – Something broke
|
||||
/// * [WARN](Level::WARN) – Something is bad
|
||||
/// * [INFO](Level::INFO) – Useful information for users
|
||||
/// * [DEBUG](Level::DEBUG) – Useful information for developers
|
||||
/// * [TRACE](Level::TRACE) – Very verbose information for developers (often for libraries)
|
||||
///
|
||||
/// ## Usage
|
||||
///
|
||||
/// You don't need to use the [Logger] struct, it's better to use the macros instead:
|
||||
///
|
||||
/// * `error!`
|
||||
/// * `warn!`
|
||||
/// * `info!`
|
||||
/// * `debug!`
|
||||
/// * `trace!`
|
||||
/// * [`error!`]
|
||||
/// * [`warn!`]
|
||||
/// * [`info!`]
|
||||
/// * [`debug!`]
|
||||
/// * [`trace!`]
|
||||
///
|
||||
/// You can however use the [Logger] struct in cases where usage of a macro is bad or
|
||||
/// You can however use the [Logger] struct in cases where usage of a macro is impossible or
|
||||
/// you are somehow working with multiple loggers. The macros offer additional functionalities,
|
||||
/// suck as full `format!` support and context, see [`tracing`], which we use as backend.
|
||||
///
|
||||
|
|
@ -364,206 +417,46 @@ pub struct Logger;
|
|||
|
||||
/// ## Main implementation
|
||||
impl Logger {
|
||||
/// Get a new [LoggerBuilder]
|
||||
/// Get a new [`LoggerBuilder`]
|
||||
#[must_use]
|
||||
pub fn builder() -> LoggerBuilder {
|
||||
LoggerBuilder::default()
|
||||
}
|
||||
|
||||
/// ## initializes the logger
|
||||
///
|
||||
/// Will enable the logger to be used.
|
||||
///
|
||||
/// Assumes some defaults, use [`init_customized`](Self::init_customized) for more control
|
||||
#[deprecated(since = "0.4.1", note = "use Logger::builder() instead")]
|
||||
pub fn build(log_dir: Option<PathBuf>, max_level: Option<Level>, uptime: bool) -> Result<Self> {
|
||||
#[allow(deprecated)]
|
||||
Self::build_customized(
|
||||
log_dir.is_some(),
|
||||
log_dir.unwrap_or(PathBuf::from(DEFAULT_LOG_DIR)),
|
||||
true,
|
||||
false,
|
||||
true,
|
||||
false,
|
||||
max_level.unwrap_or(DEFAULT_LOG_LEVEL),
|
||||
false,
|
||||
false,
|
||||
false,
|
||||
false,
|
||||
true,
|
||||
uptime,
|
||||
)
|
||||
}
|
||||
|
||||
/// ## initializes the logger
|
||||
///
|
||||
/// Will enable the logger to be used. This is a version that shows less information,
|
||||
/// useful in cases with only one sender to the logging framework.
|
||||
///
|
||||
/// Assumes some defaults, use [`init_customized`](Self::init_customized) for more control
|
||||
#[deprecated(since = "0.4.1", note = "use Logger::builder() instead")]
|
||||
pub fn build_mini(max_level: Option<Level>) -> Result<Self> {
|
||||
#[allow(deprecated)]
|
||||
Self::build_customized(
|
||||
false,
|
||||
PathBuf::from(DEFAULT_LOG_DIR),
|
||||
true,
|
||||
false,
|
||||
true,
|
||||
false,
|
||||
max_level.unwrap_or(DEFAULT_LOG_LEVEL),
|
||||
false,
|
||||
false,
|
||||
false,
|
||||
false,
|
||||
false,
|
||||
false,
|
||||
)
|
||||
}
|
||||
|
||||
/// ## initializes the logger
|
||||
///
|
||||
/// Will enable the logger to be used.
|
||||
#[deprecated(since = "0.4.1", note = "use Logger::builder() instead")]
|
||||
#[allow(clippy::too_many_arguments)]
|
||||
pub fn build_customized(
|
||||
log_to_file: bool,
|
||||
log_dir: PathBuf,
|
||||
ansi: bool,
|
||||
display_filename: bool,
|
||||
display_level: bool,
|
||||
display_target: bool,
|
||||
max_level: Level,
|
||||
display_thread_ids: bool,
|
||||
display_thread_names: bool,
|
||||
display_line_number: bool,
|
||||
pretty: bool,
|
||||
show_time: bool,
|
||||
uptime: bool, // uptime instead of system time
|
||||
) -> Result<Self> {
|
||||
// only init if no init has been performed yet
|
||||
if INITIALIZED.load(Ordering::Relaxed) {
|
||||
warn!("trying to reinitialize the logger, ignoring");
|
||||
bail!(Error::Usage("logging is already initialized".to_string()));
|
||||
}
|
||||
let subscriber = tracing_subscriber::fmt::Subscriber::builder()
|
||||
.with_level(display_level)
|
||||
.with_max_level(max_level)
|
||||
.with_ansi(ansi)
|
||||
.with_target(display_target)
|
||||
.with_file(display_filename)
|
||||
.with_thread_ids(display_thread_ids)
|
||||
.with_line_number(display_line_number)
|
||||
.with_thread_names(display_thread_names)
|
||||
.with_span_events(FmtSpan::FULL);
|
||||
// I know this is hacky, but I couldn't get it any other way. I couldn't even find a
|
||||
// project that could do it any other way. You can't apply one after another, because the
|
||||
// type is changed every time. When using Box<dyn Whatever>, some methods complain about
|
||||
// not being in trait bounds.
|
||||
// TODO: somehow find a better solution for this
|
||||
match (log_to_file, show_time, pretty, uptime) {
|
||||
(true, true, true, true) => {
|
||||
let subscriber = subscriber
|
||||
.with_writer(new_file_appender(log_dir))
|
||||
.with_timer(time::uptime())
|
||||
.pretty()
|
||||
.finish();
|
||||
tracing::subscriber::set_global_default(subscriber)?;
|
||||
}
|
||||
(true, true, true, false) => {
|
||||
let subscriber = subscriber
|
||||
.with_writer(new_file_appender(log_dir))
|
||||
.pretty()
|
||||
.finish();
|
||||
tracing::subscriber::set_global_default(subscriber)?;
|
||||
}
|
||||
(true, false, true, _) => {
|
||||
let subscriber = subscriber
|
||||
.with_writer(new_file_appender(log_dir))
|
||||
.without_time()
|
||||
.pretty()
|
||||
.finish();
|
||||
tracing::subscriber::set_global_default(subscriber)?;
|
||||
}
|
||||
(true, true, false, true) => {
|
||||
let subscriber = subscriber
|
||||
.with_writer(new_file_appender(log_dir))
|
||||
.with_timer(time::uptime())
|
||||
.finish();
|
||||
tracing::subscriber::set_global_default(subscriber)?;
|
||||
}
|
||||
(true, true, false, false) => {
|
||||
let subscriber = subscriber.with_writer(new_file_appender(log_dir)).finish();
|
||||
tracing::subscriber::set_global_default(subscriber)?;
|
||||
}
|
||||
(true, false, false, _) => {
|
||||
let file_appender = tracing_appender::rolling::daily(log_dir.clone(), "log");
|
||||
let (file_writer, _guard) = tracing_appender::non_blocking(file_appender);
|
||||
let subscriber = subscriber.with_writer(file_writer).without_time().finish();
|
||||
tracing::subscriber::set_global_default(subscriber)?;
|
||||
}
|
||||
(false, true, true, true) => {
|
||||
let subscriber = subscriber.pretty().with_timer(time::uptime()).finish();
|
||||
tracing::subscriber::set_global_default(subscriber)?;
|
||||
}
|
||||
(false, true, true, false) => {
|
||||
let subscriber = subscriber.pretty().with_timer(time::uptime()).finish();
|
||||
tracing::subscriber::set_global_default(subscriber)?;
|
||||
}
|
||||
(false, false, true, _) => {
|
||||
let subscriber = subscriber.without_time().pretty().finish();
|
||||
tracing::subscriber::set_global_default(subscriber)?;
|
||||
}
|
||||
(false, true, false, true) => {
|
||||
let subscriber = subscriber.with_timer(time::uptime()).finish();
|
||||
tracing::subscriber::set_global_default(subscriber)?;
|
||||
}
|
||||
(false, true, false, false) => {
|
||||
let subscriber = subscriber.finish();
|
||||
tracing::subscriber::set_global_default(subscriber)?;
|
||||
}
|
||||
(false, false, false, _) => {
|
||||
let subscriber = subscriber.without_time().finish();
|
||||
tracing::subscriber::set_global_default(subscriber)?;
|
||||
}
|
||||
}
|
||||
INITIALIZED.store(true, Ordering::Relaxed);
|
||||
Ok(Logger {})
|
||||
}
|
||||
|
||||
/// ## logging at [`Level::ERROR`]
|
||||
pub fn error<T>(&self, printable: T)
|
||||
where
|
||||
T: fmt::Display,
|
||||
{
|
||||
error!("{}", printable)
|
||||
error!("{}", printable);
|
||||
}
|
||||
/// ## logging at [`Level::WARN`]
|
||||
pub fn warn<T>(&self, printable: T)
|
||||
where
|
||||
T: fmt::Display,
|
||||
{
|
||||
warn!("{}", printable)
|
||||
warn!("{}", printable);
|
||||
}
|
||||
/// ## logging at [`Level::INFO`]
|
||||
pub fn info<T>(&self, printable: T)
|
||||
where
|
||||
T: fmt::Display,
|
||||
{
|
||||
info!("{}", printable)
|
||||
info!("{}", printable);
|
||||
}
|
||||
/// ## logging at [`Level::DEBUG`]
|
||||
pub fn debug<T>(&self, printable: T)
|
||||
where
|
||||
T: fmt::Display,
|
||||
{
|
||||
debug!("{}", printable)
|
||||
debug!("{}", printable);
|
||||
}
|
||||
/// ## logging at [`Level::TRACE`]
|
||||
pub fn trace<T>(&self, printable: T)
|
||||
where
|
||||
T: fmt::Display,
|
||||
{
|
||||
trace!("{}", printable)
|
||||
trace!("{}", printable);
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -586,7 +479,6 @@ impl Default for Logger {
|
|||
}
|
||||
}
|
||||
|
||||
fn new_file_appender(log_dir: PathBuf) -> NonBlocking {
|
||||
let file_appender = tracing_appender::rolling::daily(log_dir.clone(), "log");
|
||||
tracing_appender::non_blocking(file_appender).0
|
||||
fn new_file_appender(log_dir: PathBuf) -> tracing_appender::rolling::RollingFileAppender {
|
||||
tracing_appender::rolling::daily(log_dir, format!("{}.log", env!("CARGO_CRATE_NAME")))
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,72 +0,0 @@
|
|||
/target
|
||||
|
||||
# Byte-compiled / optimized / DLL files
|
||||
__pycache__/
|
||||
.pytest_cache/
|
||||
*.py[cod]
|
||||
|
||||
# C extensions
|
||||
*.so
|
||||
|
||||
# Distribution / packaging
|
||||
.Python
|
||||
.venv/
|
||||
env/
|
||||
bin/
|
||||
build/
|
||||
develop-eggs/
|
||||
dist/
|
||||
eggs/
|
||||
lib/
|
||||
lib64/
|
||||
parts/
|
||||
sdist/
|
||||
var/
|
||||
include/
|
||||
man/
|
||||
venv/
|
||||
*.egg-info/
|
||||
.installed.cfg
|
||||
*.egg
|
||||
|
||||
# Installer logs
|
||||
pip-log.txt
|
||||
pip-delete-this-directory.txt
|
||||
pip-selfcheck.json
|
||||
|
||||
# Unit test / coverage reports
|
||||
htmlcov/
|
||||
.tox/
|
||||
.coverage
|
||||
.cache
|
||||
nosetests.xml
|
||||
coverage.xml
|
||||
|
||||
# Translations
|
||||
*.mo
|
||||
|
||||
# Mr Developer
|
||||
.mr.developer.cfg
|
||||
.project
|
||||
.pydevproject
|
||||
|
||||
# Rope
|
||||
.ropeproject
|
||||
|
||||
# Django stuff:
|
||||
*.log
|
||||
*.pot
|
||||
|
||||
.DS_Store
|
||||
|
||||
# Sphinx documentation
|
||||
docs/_build/
|
||||
|
||||
# PyCharm
|
||||
.idea/
|
||||
|
||||
# VSCode
|
||||
.vscode/
|
||||
|
||||
# Pyenv
|
||||
.python-version
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
[package]
|
||||
name = "libpt-py"
|
||||
version.workspace = true
|
||||
edition.workspace = true
|
||||
authors.workspace = true
|
||||
license.workspace = true
|
||||
description.workspace = true
|
||||
readme.workspace = true
|
||||
homepage.workspace = true
|
||||
repository.workspace = true
|
||||
keywords.workspace = true
|
||||
categories.workspace = true
|
||||
|
||||
[package.metadata.maturin]
|
||||
name = "libpt"
|
||||
|
||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||
[lib]
|
||||
crate-type = ["cdylib", "rlib"]
|
||||
|
||||
[dependencies]
|
||||
libpt = { version = "0.5.0", path = "../.." }
|
||||
pyo3 = { version = "0.19.0", features = ["full"] }
|
||||
anyhow.workspace = true
|
||||
|
||||
[features]
|
||||
default = ["log", "core", "full"]
|
||||
core = []
|
||||
full = ["default", "core", "log", "bintols"]
|
||||
log = ["libpt/log"]
|
||||
bintols = ["libpt/bintols", "log"]
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
[build-system]
|
||||
requires = ["maturin>=1.4,<2.0"]
|
||||
build-backend = "maturin"
|
||||
|
||||
[project]
|
||||
name = "libpt"
|
||||
requires-python = ">=3.8"
|
||||
classifiers = [
|
||||
"Programming Language :: Rust",
|
||||
"Programming Language :: Python :: Implementation :: CPython",
|
||||
"Programming Language :: Python :: Implementation :: PyPy",
|
||||
]
|
||||
dynamic = ["version"]
|
||||
|
||||
[tool.maturin]
|
||||
features = ["pyo3/extension-module"]
|
||||
|
|
@ -1,76 +0,0 @@
|
|||
use pyo3::prelude::*;
|
||||
|
||||
use libpt::bintols as origin;
|
||||
|
||||
mod split {
|
||||
use libpt::bintols::split as origin;
|
||||
use pyo3::prelude::*;
|
||||
|
||||
#[pyfunction]
|
||||
pub fn split_int(data: u128) -> Vec<u8> {
|
||||
origin::unsigned_to_vec(data)
|
||||
}
|
||||
|
||||
/// implement a python module in Rust
|
||||
pub fn submodule(py: Python, parent: &PyModule) -> PyResult<()> {
|
||||
let module = PyModule::new(py, "split")?;
|
||||
|
||||
module.add_function(wrap_pyfunction!(split_int, module)?)?;
|
||||
|
||||
parent.add_submodule(module)?;
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
mod display {
|
||||
use libpt::bintols::display as origin;
|
||||
use pyo3::prelude::*;
|
||||
|
||||
#[pyfunction]
|
||||
pub fn bytes_to_bin(data: &[u8]) -> String {
|
||||
origin::bytes_to_bin(data)
|
||||
}
|
||||
|
||||
#[pyfunction]
|
||||
pub fn byte_bit_display(data: usize) -> String {
|
||||
origin::byte_bit_display(data)
|
||||
}
|
||||
|
||||
#[pyfunction]
|
||||
pub fn humanbytes(total: u128) -> String {
|
||||
origin::humanbytes(total)
|
||||
}
|
||||
|
||||
/// implement a python module in Rust
|
||||
pub fn submodule(py: Python, parent: &PyModule) -> PyResult<()> {
|
||||
let module = PyModule::new(py, "display")?;
|
||||
|
||||
module.add_function(wrap_pyfunction!(bytes_to_bin, module)?)?;
|
||||
module.add_function(wrap_pyfunction!(byte_bit_display, module)?)?;
|
||||
module.add_function(wrap_pyfunction!(humanbytes, module)?)?;
|
||||
|
||||
parent.add_submodule(module)?;
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
/// implement a python module in Rust
|
||||
pub fn submodule(py: Python, parent: &PyModule) -> PyResult<()> {
|
||||
let module = PyModule::new(py, "bintols")?;
|
||||
|
||||
// binary constants
|
||||
module.add("KIBI", origin::KIBI)?;
|
||||
module.add("MEBI", origin::MEBI)?;
|
||||
module.add("GIBI", origin::GIBI)?;
|
||||
module.add("TEBI", origin::TEBI)?;
|
||||
module.add("PEBI", origin::PEBI)?;
|
||||
module.add("EXBI", origin::EXBI)?;
|
||||
module.add("ZEBI", origin::ZEBI)?;
|
||||
module.add("YOBI", origin::YOBI)?;
|
||||
|
||||
display::submodule(py, module)?;
|
||||
split::submodule(py, module)?;
|
||||
|
||||
parent.add_submodule(module)?;
|
||||
Ok(())
|
||||
}
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
use pyo3::prelude::*;
|
||||
|
||||
mod printing;
|
||||
|
||||
/// implement a python module in Rust
|
||||
pub fn submodule(py: Python, parent: &PyModule) -> PyResult<()> {
|
||||
let module = PyModule::new(py, "core")?;
|
||||
printing::submodule(py, module)?;
|
||||
parent.add_submodule(module)?;
|
||||
Ok(())
|
||||
}
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
use pyo3::prelude::*;
|
||||
|
||||
use libpt::core::printing as origin;
|
||||
|
||||
/// Quickly get a one line visual divider
|
||||
#[pyfunction]
|
||||
pub fn divider() -> String {
|
||||
origin::divider()
|
||||
}
|
||||
|
||||
/// Quickly print a one line visual divider
|
||||
#[pyfunction]
|
||||
pub fn print_divider() {
|
||||
origin::print_divider()
|
||||
}
|
||||
|
||||
/// implement a python module in Rust
|
||||
pub fn submodule(py: Python, parent: &PyModule) -> PyResult<()> {
|
||||
let module = PyModule::new(py, "printing")?;
|
||||
module.add_function(wrap_pyfunction!(divider, module)?)?;
|
||||
module.add_function(wrap_pyfunction!(print_divider, module)?)?;
|
||||
parent.add_submodule(module)?;
|
||||
Ok(())
|
||||
}
|
||||
|
|
@ -1,30 +0,0 @@
|
|||
//! Python bindings for [`libpt`](libpt)
|
||||
|
||||
#[cfg(feature = "bintols")]
|
||||
mod bintols;
|
||||
#[cfg(feature = "core")]
|
||||
mod core;
|
||||
#[cfg(feature = "log")]
|
||||
mod log;
|
||||
|
||||
use pyo3::prelude::*;
|
||||
|
||||
/// return the version of libpt
|
||||
#[pyfunction]
|
||||
fn version() -> String {
|
||||
env!("CARGO_PKG_VERSION").to_string()
|
||||
}
|
||||
|
||||
/// implement a python module in Rust
|
||||
#[pymodule]
|
||||
#[pyo3(name = "libpt")]
|
||||
fn libpt_py(py: Python, m: &PyModule) -> PyResult<()> {
|
||||
m.add_function(wrap_pyfunction!(version, m)?)?;
|
||||
#[cfg(feature = "core")]
|
||||
core::submodule(py, m)?;
|
||||
#[cfg(feature = "log")]
|
||||
log::submodule(py, m)?;
|
||||
#[cfg(feature = "bintols")]
|
||||
bintols::submodule(py, m)?;
|
||||
Ok(())
|
||||
}
|
||||
|
|
@ -1,91 +0,0 @@
|
|||
use std::path::PathBuf;
|
||||
|
||||
use pyo3::prelude::*;
|
||||
|
||||
use libpt::log as origin;
|
||||
|
||||
#[derive(Clone)]
|
||||
#[pyclass]
|
||||
pub enum Level {
|
||||
Error,
|
||||
Warn,
|
||||
Info,
|
||||
Debug,
|
||||
Trace,
|
||||
}
|
||||
|
||||
impl From<Level> for origin::Level {
|
||||
fn from(value: Level) -> Self {
|
||||
match value {
|
||||
Level::Error => origin::Level::ERROR,
|
||||
Level::Warn => origin::Level::WARN,
|
||||
Level::Info => origin::Level::INFO,
|
||||
Level::Debug => origin::Level::DEBUG,
|
||||
Level::Trace => origin::Level::TRACE,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[pyclass]
|
||||
pub struct Logger {
|
||||
inner: origin::Logger,
|
||||
}
|
||||
|
||||
impl From<origin::Logger> for Logger {
|
||||
fn from(inner: origin::Logger) -> Self {
|
||||
Self { inner }
|
||||
}
|
||||
}
|
||||
|
||||
#[pymethods]
|
||||
impl Logger {
|
||||
#[new]
|
||||
pub fn build(
|
||||
log_dir: Option<PathBuf>,
|
||||
max_level: Option<Level>,
|
||||
uptime: Option<bool>,
|
||||
) -> anyhow::Result<Self> {
|
||||
// concert our wrapper type
|
||||
let max_level = max_level.map(origin::Level::from);
|
||||
let mut builder = origin::Logger::builder();
|
||||
if log_dir.is_some() {
|
||||
builder = builder.log_dir(log_dir.unwrap());
|
||||
}
|
||||
if max_level.is_some() {
|
||||
builder = builder.max_level(max_level.unwrap());
|
||||
}
|
||||
if uptime.is_some() {
|
||||
builder = builder.uptime(uptime.unwrap());
|
||||
}
|
||||
Ok(builder.build()?.into())
|
||||
}
|
||||
|
||||
/// ## logging at [`Level::ERROR`]
|
||||
pub fn error(&self, printable: String) {
|
||||
self.inner.error(printable)
|
||||
}
|
||||
/// ## logging at [`Level::WARN`]
|
||||
pub fn warn(&self, printable: String) {
|
||||
self.inner.warn(printable)
|
||||
}
|
||||
/// ## logging at [`Level::INFO`]
|
||||
pub fn info(&self, printable: String) {
|
||||
self.inner.info(printable)
|
||||
}
|
||||
/// ## logging at [`Level::DEBUG`]
|
||||
pub fn debug(&self, printable: String) {
|
||||
self.inner.debug(printable)
|
||||
}
|
||||
/// ## logging at [`Level::StringRACE`]
|
||||
pub fn trace(&self, printable: String) {
|
||||
self.inner.trace(printable)
|
||||
}
|
||||
}
|
||||
|
||||
/// implement a python module in Rust
|
||||
pub fn submodule(py: Python, parent: &PyModule) -> PyResult<()> {
|
||||
let module = PyModule::new(py, "log")?;
|
||||
module.add_class::<Logger>()?;
|
||||
parent.add_submodule(module)?;
|
||||
Ok(())
|
||||
}
|
||||
|
|
@ -5,9 +5,12 @@
|
|||
//!
|
||||
//! `pt` is a project consisting of multiple smaller crates, all bundled together in this
|
||||
//! "main crate". Most crates will only show up if you activate their feature.
|
||||
#![warn(clippy::pedantic, clippy::style, clippy::nursery)]
|
||||
#[cfg_attr(docsrs, doc(cfg(feature = "full")))]
|
||||
#[cfg(feature = "bintols")]
|
||||
pub use libpt_bintols as bintols;
|
||||
#[cfg(feature = "cli")]
|
||||
pub use libpt_cli as cli;
|
||||
#[cfg(feature = "core")]
|
||||
pub use libpt_core as core;
|
||||
#[cfg(feature = "log")]
|
||||
|
|
|
|||
Reference in New Issue