zerumarex/pyqt6-scaffold
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Initial Commit

Browse source
This commit is contained in:
Daniel Haus 2026-03-06 16:05:24 +03:00
commit 4dbdc7d793
18 changed files with 2384 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
.gitignore vendored Normal file
View file

@ -0,0 +1,5 @@
.venv
.env
__pycache__
*.pyc
.idea

840
LICENSE Normal file
View file

@ -0,0 +1,840 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.
"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.
A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".
The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.
The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.
1. Exception to Section 3 of the GNU GPL.
You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.
2. Conveying Modified Versions.
If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:
a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or
b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.
3. Object Code Incorporating Material from Library Header Files.
The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:
a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the object code with a copy of the GNU GPL and this license
document.
4. Combined Works.
You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:
a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.
c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.
d) Do one of the following:
0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.
1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.
e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)
5. Combined Libraries.
You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:
a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.
b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.
6. Revised Versions of the GNU Lesser General Public License.
The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser 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
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.
If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

315
README.md Normal file
View file

@ -0,0 +1,315 @@
# PyQt6 Scaffold
A wrapper for PyQt6 designed for a more convenient workflow.
[Русскоязычная Документация](docs/README.ru.md)
## License
This project is licensed under the LGPLv3 license.
See the LICENSE file for details.
# Description
This library provides a set of ready-to-use patterns and tools that can be immediately integrated into development to avoid common pitfalls in complex areas (such as database management or window navigation).
The library is divided into two main modules:
- Core
- Contrib
## Installation
Base installation (core only):
```bash
pip install pyqt6-scaffold
```
With MySQL support:
```bash
pip install pyqt6-scaffold[mysql]
```
With PostgreSQL support:
```bash
pip install pyqt6-scaffold[postgres]
```
All drivers at once:
```bash
pip install pyqt6-scaffold[all]
```
## Quick Start
### 1. Configure Environment Variables
Create a start.sh (Linux/macOS) or start.cmd (Windows) file:
```bash
# start.sh
export MYSQL_HOST=localhost
export MYSQL_PORT=3306
export MYSQL_USER=root
export MYSQL_DATABASE=mydb
export MYSQL_PASSWORD=secret
python main.py
```
```powershell
:: start.cmd
set MYSQL_HOST=localhost
set MYSQL_PORT=3306
set MYSQL_USER=root
set MYSQL_DATABASE=mydb
set MYSQL_PASSWORD=secret
python main.py
```
### 2. Implement the Database
```python
from pyqt6_scaffold import BaseUser
from pyqt6_scaffold.contrib import MysqlDatabase
class AppDatabase(MysqlDatabase):
def auth(self, login: str, password: str):
with self.execute(
f"SELECT id, name FROM users WHERE login = {self.placeholder} AND password = {self.placeholder}",
(login, password)
) as cursor:
row = cursor.fetchone()
if not row:
return None
return BaseUser(id=row[0], name=row[1], role=None)
```
### 3. Create Windows
```python
from pyqt6_scaffold import BaseWindow
from PyQt6.QtWidgets import QLabel, QLineEdit, QPushButton, QVBoxLayout, QWidget
class LoginWindow(BaseWindow):
def _define_widgets(self):
self._login_input = QLineEdit()
self._password_input = QLineEdit()
self._password_input.setEchoMode(QLineEdit.EchoMode.Password)
self._submit_btn = QPushButton("Login")
def _tune_layouts(self):
layout = QVBoxLayout()
layout.addWidget(QLabel("Login:"))
layout.addWidget(self._login_input)
layout.addWidget(QLabel("Password:"))
layout.addWidget(self._password_input)
layout.addWidget(self._submit_btn)
container = QWidget()
container.setLayout(layout)
self.setCentralWidget(container)
def _connect_slots(self):
self._submit_btn.clicked.connect(self._on_submit)
def _apply_windows_settings(self):
self.setWindowTitle("Login")
def _on_submit(self):
user = self._db.auth(
self._login_input.text(),
self._password_input.text()
)
if user is None:
return
from pyqt6_scaffold import NavigateRequest, NavigationContext
self._composer.navigate_request.emit(
NavigateRequest(
target="main",
context=NavigationContext(data={"user": user})
)
)
class MainWindow(BaseWindow):
def _apply_windows_settings(self):
self.setWindowTitle("Main Window")
```
### 4. Assemble the Application in main.py
```python
import sys
from PyQt6.QtWidgets import QApplication
from pyqt6_scaffold import Composer
def main():
app = QApplication(sys.argv)
db = AppDatabase()
db.connect()
composer = Composer(app=app, db=db)
composer.register("login", LoginWindow)
composer.register("main", MainWindow)
sys.exit(composer.run(start="login"))
if __name__ == "__main__":
main()
```
## Core Module
The module providing essential tools for development, usually in the form of abstract classes that implement a convenient pattern. For example, the BaseWindow class implements a minimally acceptable (in the author's opinion) pattern for an application window:
```python
from PyQt6.QtWidgets import QMainWindow
class BaseWindow(QMainWindow):
def __init__(self, composer, db):
super().__init__()
self._db = db
self._composer = composer
self._define_widgets()
self._tune_layouts()
self._connect_slots()
self._apply_windows_settings()
def _define_widgets(self): pass
def _tune_layouts(self): pass
def _connect_slots(self): pass
def _apply_windows_settings(self): pass
```
The main components of the Core module are the navigation and database interaction classes.
### Database
The `AbstractDatabase` class is responsible for database management within the library.
The class structure looks approximately like this:
![AbstractDatabase](https://www.plantuml.com/plantuml/svg/NP1HIiKm44N_iue1Vz9QDr0GdY2kmFzXcWuQJ9EQcMX5tBlfwwkLbw-RcplSapc9KjOo1UC2YS3389h9wICf3IGCtmRgkGDqASPTruntQixNMq3qqIkYtUmUXfG2tCDpBjnSCkiqExKjvHVfe6tVFbUrFuzUziJLX4_nOl32hYXRUGyzrAeEPieqIGzQvi2rq3OTKD7aqZJvW-E9Wlo1879KpeZsdxESyNbng5ypTx2g3mgRqA7PVde3U41knXp8yMiA8sVpOquSnxhANm00)
This is an abstract class that must be overridden in a subclass. Let's break it down in detail:
- **Class Constructor**:
- Contains a single argument: **strict**. This affects how the system reacts when a user opens a new connection, as the default assumption is that the user will use only one connection for database interaction. If **strict** = True and the class already holds a reference to an existing connection (_conn != None), the execution will fail with an error. If **strict** = False, the old connection will be closed and the class will create a new connection to the database.
- **connect()**: A context-independent method for creating a database connection. Internally, it calls the private method `_connect()`, which is context-dependent on the SQL dialect and must be overridden by the user in the subclass.
- In the `_connect()` method, the user implements the specific database connection logic for their chosen SQL dialect. The method should return a connection object, typically resembling: `your_sql_dialect_connection.connect(**DB_CONFIG)`
- **disconnect()**: A context-independent method for manually closing the database connection.
- **connection**: A getter for the `_conn` field, returning the current database connection.
- **execute()**: A context-independent method for executing database code. It handles opening a connection cursor and executing the user's query. It consists of several components:
- **CursorContext**: A context-independent wrapper class for the cursor object. It is required for compatibility and using the cursor within a context manager, proxying all cursor methods to make it programmatically equivalent to a cursor object.
- **placeholder**: A context-dependent getter for the SQL dialect's specific placeholder used for value substitution; must be overridden by the user.
- **Method Arguments**: `execute()` takes only 2 arguments: `autocommit (bool)` and `params (tuple)`. The first regulates database behavior during data changes—whether to apply them immediately or require the user to do so manually. The second argument passes the values for substitution.
- If query execution fails, the method will automatically roll back any changes in the database.
#### Database Models
As is common knowledge, interaction between the database and the frontend in PyQt6 is implemented through a system of models and views. This library redefines models for tables, lists, and cards, implementing a compatible interface for the database management logic described above.
The model logic in the library is represented by three model classes and one auxiliary mixin class:
- **DataMixin** A mixin for Qt models (`QAbstractTableModel` / `QAbstractListModel`). It contains shared logic for data storage, model updates, and row styling. `DataMixin` is used alongside Qt models and is not intended for standalone use. It simplifies the implementation of common model functions so that specific classes can focus on business logic.
Provides methods for:
- data storage (`_data`)
- model reloading (`refresh`)
- row access (`row_data`)
- styling (`row_background`, `row_foreground`, `row_font`)
- **BaseTableModel** A table model based on a list of row tuples. It supports displaying data in a table with column headers, access to raw data, and cell styling via mixin methods. Intended for scenarios where data is naturally represented as a table (e.g., lists of objects with fixed fields).
- **BaseListModel** A list model where each entry is represented as a list item. Text display is handled via the `row_display()` method. Suitable for simple lists, comboboxes, and other views where a table structure is not required.
- **BaseCardModel** A model for card-based or custom-drawn views.
Does not implement `DisplayRole`—visualization is delegated to a `QStyledItemDelegate`. This allows for building complex UI components (cards, tiles, custom lists) while maintaining data access via `UserRole`.
### Composer
The Composer class is the application's router and window lifecycle manager. It is responsible for window registration, navigation between them, and storing the active database connection. The Composer acts as the application's central hub, through which view switching and context passing occur.
![Composer](https://www.plantuml.com/plantuml/svg/NL31RiCW3Btp5LPFYPPgznocIki_x31Do2LMYqGWmyxIhjg_BmkGgU72y_F33xy32qOPUwUCGsPu3VqGc2BS5Snd3xex5MJ66CbBAN4O2enqjYpn1YqShP7t6JSB-jYyrKQkMQIMrXDu_B9d5DAHFaVYbTVQUYjQLxDF0zsfphm9NkWgkKhE52kFFJKmMT-5gG67txTwOr1bWyB7qLVBzdNv94zMp4Md8LMwrgQ9X4AvkTZLwaVbsDuM5kx_p145JyYKk3NM_VwbY5j88ncU8JaJFmhN6IrSWkluRtTFHcpmZyBTDiGTjC3sxD6f0_bkxDql)
Let's examine its structure:
- **Class Constructor**:
- Contains 2 arguments: **app** and **db**. **app** is a reference to the PyQt6 event loop object, and **db** is a reference to the database object.
- Internally initializes 5 fields:
- **_db**: Stores a reference to the database object.
- **_current**: Stores a reference to the active window.
- **_app**: Stores a reference to the PyQt6 event loop object.
- **_registry**: Stores a reference to the composer's registry, which is a "key-value" store (Python dict) containing mappings between a string name and a window class reference.
- The entry template in the composer registry is defined in the `register()` method and looks like this:
```python
{
"class": window,
"instance": None,
"lazy": lazy
}
```
- The **class** field is a reference to the window class.
- The **instance** field is a reference to the window object (if created).
- The **lazy** field is a setting for window object creation. If `lazy = True`, the window object is created at the moment of the switch request. If `lazy = False`, the object is created immediately during registration. The former is better if the window content is context-dependent.
- **_current_ctx**: Stores the context of the active window as a "key-value" store. The context is unique to each window and is overwritten when switching. It can contain any key-value pairs used for window needs (e.g., if using RBAC, it is logical to store a user rights object here). The context is set during the `Maps()` slot call. It is assumed the starting window should not contain a context.
- **register()**: A method for creating a new entry in the composer registry. If the class passed in the `window` argument is not a subclass of `BaseWindow`, a Python exception will be raised.
- **navigate_request**: The composer's only signal. It should be emitted when the user needs to switch windows, passing a reference to the `NavigationRequest` dataclass.
- **navigate()**: The method managing window switching. It is a PyQt6 slot and should not be called directly, as it is triggered automatically by the `Maps_request` signal.
- **NavigationRequest** is a dataclass consisting of `target: str` and `context: NavigationContext` fields. It carries the switch request context, which consists of the target window name and the window class reference. In turn, the **NavigationContext** dataclass consists of a single `data` field which stores the window context.
Switching between windows is performed via the Composer class's programmatic interface, a reference to which all windows should receive by default (see Window Template above).
## Contrib Module
The `contrib` module contains ready-to-use implementations for common use cases. Unlike `core`, `contrib` is context-dependent and provides specific solutions that a student can use as-is or as a foundation.
### Backends
Ready-made implementations of `AbstractDatabase` for three SQL dialects:
```python
from pyqt6_scaffold.contrib import PostgresqlDatabase, MysqlDatabase, SqliteDatabase
```
Each backend reads configuration from environment variables:
| Class | Environment Variables |
|--------------------|--------------------------------------------------------------------|
| PostgresqlDatabase | PG_HOST, PG_PORT, PG_USER, PG_DATABASE, PG_PASSWORD |
| MysqlDatabase | MYSQL_HOST, MYSQL_PORT, MYSQL_USER, MYSQL_DATABASE, MYSQL_PASSWORD |
| SqliteDatabase | SQLITE_PATH |
### Auth
Authorization system based on RBAC (Role-Based Access Control):
```python
from pyqt6_scaffold.contrib.auth import RBACMixin, Role, RoleLevel
```
**Role** and **RoleLevel** — a dataclass and an enum for describing user roles:
```python
from pyqt6_scaffold.contrib.auth import Role, RoleLevel
from pyqt6_scaffold import BaseUser
role = Role(name="Manager", level=RoleLevel.MANAGER.value)
user = BaseUser(id=1, name="Ivan", role=role)
```
**RBACMixin** — a mixin that adds the `can()` method to your database.
It assumes the existence of a `permission_map` table in the database:
```sql
CREATE TABLE permission_map (
perm VARCHAR(50),
min_level INT
);
INSERT INTO permission_map VALUES ('edit.products', 50);
INSERT INTO permission_map VALUES ('delete.products', 100);
INSERT INTO permission_map VALUES ('view.products', 0);
...
```
Usage:
```python
from pyqt6_scaffold.contrib import MysqlDatabase
from pyqt6_scaffold.contrib.auth import RBACMixin
class AppDatabase(RBACMixin, MysqlDatabase):
def auth(self, login, password): ...
db = AppDatabase()
db.connect()
db.can(user, "edit.products") # True if user.role.level >= 50
db.can(user, "delete.products") # False if user.role.level < 100
```
Table and column names can be overridden:
```python
class AppDatabase(RBACMixin, MysqlDatabase):
permission_table = "rights"
permission_column = "action"
level_column = "required_level"
```

321
docs/README.ru.md Normal file
View file

@ -0,0 +1,321 @@
# PyQt6 Scaffold
Обёртка для PyQt6, делающая работу удобнее
[English documentation](../README.md)
## Лицензия
Этот проект лицензирован под лицензией LGPLv3.
Для подробностей ознакомьтесь с файлом LICENSE.
# Описание
Эта библиотека предоставляет набор готовых паттернов и инструментов, которые можно сразу использовать для разработки и избежать ошибок в сложных местах (вроде базы данных или навигации между окнами)
Библиотека делится на 2 больших модуля:
- Core
- Contrib
## Установка
Базовая установка (только ядро):
```bash
pip install pyqt6-scaffold
```
С поддержкой MySQL:
```bash
pip install pyqt6-scaffold[mysql]
```
С поддержкой PostgreSQL:
```bash
pip install pyqt6-scaffold[postgres]
```
Все драйверы сразу:
```bash
pip install pyqt6-scaffold[all]
```
## Быстрый старт
### 1. Настройте переменные окружения
Создайте файл `start.sh` (Linux/macOS) или `start.cmd` (Windows):
```bash
# start.sh
export MYSQL_HOST=localhost
export MYSQL_PORT=3306
export MYSQL_USER=root
export MYSQL_DATABASE=mydb
export MYSQL_PASSWORD=secret
python main.py
```
```cmd
:: start.cmd
set MYSQL_HOST=localhost
set MYSQL_PORT=3306
set MYSQL_USER=root
set MYSQL_DATABASE=mydb
set MYSQL_PASSWORD=secret
python main.py
```
### 2. Реализуйте базу данных
```python
from pyqt6_scaffold import BaseUser
from pyqt6_scaffold.contrib import MysqlDatabase
class AppDatabase(MysqlDatabase):
def auth(self, login: str, password: str):
with self.execute(
f"SELECT id, name FROM users WHERE login = {self.placeholder} AND password = {self.placeholder}",
(login, password)
) as cursor:
row = cursor.fetchone()
if not row:
return None
return BaseUser(id=row[0], name=row[1], role=None)
```
### 3. Создайте окна
```python
from pyqt6_scaffold import BaseWindow
from PyQt6.QtWidgets import QLabel, QLineEdit, QPushButton, QVBoxLayout, QWidget
class LoginWindow(BaseWindow):
def _define_widgets(self):
self._login_input = QLineEdit()
self._password_input = QLineEdit()
self._pas3. Create Windowssword_input.setEchoMode(QLineEdit.EchoMode.Password)
self._submit_btn = QPushButton("Войти")
def _tune_layouts(self):
layout = QVBoxLayout()
layout.addWidget(QLabel("Логин:"))
layout.addWidget(self._login_input)
layout.addWidget(QLabel("Пароль:"))
layout.addWidget(self._password_input)
layout.addWidget(self._submit_btn)
container = QWidget()
container.setLayout(layout)
self.setCentralWidget(container)
def _connect_slots(self):
self._submit_btn.clicked.connect(self._on_submit)
def _apply_windows_settings(self):
self.setWindowTitle("Вход")
def _on_submit(self):
user = self._db.auth(
self._login_input.text(),
self._password_input.text()
)
if user is None:
return
from pyqt6_scaffold import NavigateRequest, NavigationContext
self._composer.navigate_request.emit(
NavigateRequest(
target="main",
context=NavigationContext(data={"user": user})
)
)
class MainWindow(BaseWindow):
def _apply_windows_settings(self):
self.setWindowTitle("Главное окно")
```
### 4. Соберите приложение в main.py
```python
import sys
from PyQt6.QtWidgets import QApplication
from pyqt6_scaffold import Composer
def main():
app = QApplication(sys.argv)
db = AppDatabase()
db.connect()
composer = Composer(app=app, db=db)
composer.register("login", LoginWindow)
composer.register("main", MainWindow)
sys.exit(composer.run(start="login"))
if __name__ == "__main__":
main()
```
## Модуль Сore
Модуль, предоставляющий основные инструменты для работы, как правило это абстрактные классы, реализующие удобный шаблон для разработки. Например, класс BaseWindow реализующий минимально приемлемый (по мнению автора) шаблон для окна приложения:
```python
from PyQt6.QtWidgets import QMainWindow
class BaseWindow(QMainWindow):
def __init__(self, composer, db):
super().__init__()
self._db = db
self._composer = composer
self._define_widgets()
self._tune_layouts()
self._connect_slots()
self._apply_windows_settings()
def _define_widgets(self): pass
def _tune_layouts(self): pass
def _connect_slots(self): pass
def _apply_windows_settings(self): pass
```
Главные составляюшие модуля Core это классы навигации и взаимодействия с базой данных.
### База Данных
За управление базой данных в библиотеке отвечает класс ```AbstractDatabase```.
Этот класс выглядит примерно так:
![AbstractDatabase](https://www.plantuml.com/plantuml/svg/NP1HIiKm44N_iue1Vz9QDr0GdY2kmFzXcWuQJ9EQcMX5tBlfwwkLbw-RcplSapc9KjOo1UC2YS3389h9wICf3IGCtmRgkGDqASPTruntQixNMq3qqIkYtUmUXfG2tCDpBjnSCkiqExKjvHVfe6tVFbUrFuzUziJLX4_nOl32hYXRUGyzrAeEPieqIGzQvi2rq3OTKD7aqZJvW-E9Wlo1879KpeZsdxESyNbng5ypTx2g3mgRqA7PVde3U41knXp8yMiA8sVpOquSnxhANm00)
Это абстрактный класс который необходимо переопределить в классе наследнике. Разберём его подробнее:
- Конструктор класса:
- Содержит всего один аргумент: **strict**, он влияет на то, как реагировать на открытие пользователем нового соединения, так как по умолчанию предполагается что пользователь будет использовать только одно соедниение для взаимодействия с базой данных. Если **strict** = True, то в случае если класс уже хранит ссылку на существующее соедниение (_conn != None), то выполнение кода завершится с ошибкой. Если **strict** = False, то старое соединение закроется и класс создаст новое соедниение с базой данных.
- *connect()* это контекстно независимый метод для создания соединения с базой данных. Внутри себя он вызывает приватный метод *_connect()*, который является контекстно зависимым от диалекта SQL и должен быть переопределён пользователем в классе наследнике
- В методе *_connect()* пользователь реализует специфичную для используемого им диалекта SQL логику подключения к базе данных. Метод должен возвращать объект содениения, как правило он выглядит как: ```your_sql_dialect_connection.connect(**DB_CONFIG)```
- *disconnect()* это контекстно независимый метод для ручного закрытия соединения с базой данных
- *connection* это геттер для поля _conn, возвращает текущее соедниение с базой данных.
- *execute()* это контекстно независимый метод для выполнения кода базы данных, состоит из открытия курсора соединения и выполнения запроса пользователя через курсор, состоит из нескольких компонентов:
- *CursorContext* - контекстно независимый класс-обёртка над объектом курсора, необходим для совместимости и использовании курсора в контекстном менеджере, проксирует все методы курсора делая его программно эквивалентом объекта курсора
- *placeholder* - контекстно зависимый геттер для placeholder'а специфичного диалекта SQL для подстановки значений, должен быть переопределён пользователем.
- Аргументы метода: execute() принимает всего 2 аргумента: autocommit(bool) и params(tuple). Первый регулирует поведение базы данных при изменении данных - применять ли их сразу или просить пользтвателя сделать это вручную. Второй аргумент передаёт значения для подстановки.
- В случае если выполнение запроса завершится с ошибкой, метод автоматически откатит изменения в базе данных (если они были)
#### Модели базы данных
Как известно, взаимодействия между базой данных и фронтендом в PyQt6 реализовано через систему моделей (model) и представлений (view), в данной библиотеке заного определены модели для таблиц, списков и карточек, реализующие совместимый интерфейс для логики организации управления базами данных данной библиотеки, описанной выше.
Логика моделей в библиотеке представлена 3-мя классами модели и одним вспомогательным классом миксином:
- *DataMixin*
Миксин для моделей Qt (QAbstractTableModel / QAbstractListModel). Содержит общую логику хранения данных, обновления модели и стилизации строк. Миксин DataMixin используется совместно с Qt-моделями и не предназначен для самостоятельного использования. Он упрощает реализацию общих функций модели, чтобы конкретные классы сосредоточились на бизнес-логике.
Предоставляет методы для:
- хранения данных (_data)
- перезагрузки модели (refresh)
- доступа к строкам (row_data)
- стилизации (row_background, row_foreground, row_font)
- *BaseTableModel*
Табличная модель, основанная на списке кортежей (row tuples). Поддерживает отображение данных в таблице с заголовками колонок, доступ к сырым данным и стилизацию ячеек через методы миксина. Предназначена для сценариев, где данные естественно представимы в виде таблицы (например, списки объектов с фиксированными полями).
- *BaseListModel*
Листовая модель, в которой каждая запись представлена как элемент списка. Отображение текста выполняется через метод row_display(). Подходит для простых списков, комбобоксов и других представлений, где не требуется табличная структура.
- *BaseCardModel*
Модель для карточных или кастомно отрисованных представлений.
Не реализует DisplayRole — визуализация делегируется QStyledItemDelegate. Позволяет строить сложные UI-компоненты (карточки, плитки, кастомные списки), сохраняя доступ к данным через UserRole.
### Composer
Класс-композитор — это маршрутизатор приложения и менеджер жизненного цикла окон. Он отвечает за регистрацию окон, навигацию между ними и хранение активного соединения с базой данных. Composer выступает центральным хабом приложения, через который происходит переключение представлений и передача контекста.
![Composer](https://www.plantuml.com/plantuml/svg/NL31RiCW3Btp5LPFYPPgznocIki_x31Do2LMYqGWmyxIhjg_BmkGgU72y_F33xy32qOPUwUCGsPu3VqGc2BS5Snd3xex5MJ66CbBAN4O2enqjYpn1YqShP7t6JSB-jYyrKQkMQIMrXDu_B9d5DAHFaVYbTVQUYjQLxDF0zsfphm9NkWgkKhE52kFFJKmMT-5gG67txTwOr1bWyB7qLVBzdNv94zMp4Md8LMwrgQ9X4AvkTZLwaVbsDuM5kx_p145JyYKk3NM_VwbY5j88ncU8JaJFmhN6IrSWkluRtTFHcpmZyBTDiGTjC3sxD6f0_bkxDql)
Разберём его устройство:
- Конструктор класса:
- Содержит 2 аргумента: **app** и **db**. **app** это ссылка на объект цикла событий PyQt6, **db** это ссылка на объект базы данных.
- Внутри себя инициализирует 5 полей:
- *_db* - хранит ссылку на объект базы данных
- *_current* - хранит ссылку на активное окно
- *_app* - хранит ссылку на объект цикла событий PyQt6
- *_registry* - хранит ссылку регистр композитора, который в свою очередь хранит базу данных формата "ключ-значение" (словарь/dict python), содержащую сопоставление строкового названия окна и ссылку на класс окна.
- Шаблон записи в регистре композитора определён в методе *register()* и выглядит так:
```
{
"class": window,
"instance": None,
"lazy": lazy
}
```
- Поле **class** это ссылка на класс окна
- Поле **instance** это ссылка на объект окна (если он создан)
- Поле **lazy** это настройка создания объекта окна. Если lazy = True, тогда объект окна создаётся в момент запроса на переключение на это окно. Если lazy = False, тогда объект окна создаётся сразу при регистрации окна в регистре композитора. Первый вариант больше подходит если содержимое окна контекстно зависимо.
- *_current_ctx* - хранит контекст активного окна, представляет собой базу данных формата "ключ-значение" (словарь/dict python). Контекст уникален для каждого окна и перезаписывается при переключении окон. Может содержать любые записи "ключ-значение", информация из контекста используется для нужд окна (например, если пользователь использует RBAC как систему аутентификации, логично хранить объект с правами пользователя в контексте окна). Контекст задаётся во время вызова слота *navigate()*. Предполагается что стартовое окно контекст содержать не должно
- *register()* - метод создающий новую запись в регистре композитора. Если класс передающийся в аргумент window не является наследником BaseWindow, произойдёт исключение Python.
- *navigate_request* - единственный сигнал класса композитора, эмит сигнала должен происходить в случае если пользователю требуется переключить окно, передаёт ссылку на датакласс NavigationRequest.
- *navigate()* - метод управляющий переключением окон. Является слотом PyQt6 и напрямую не должен вызываться, так как вызывается автоматически при эмитте сигнала *navigate_request*.
- *NavigationRequest* это датакласс, который состоит из полей *target: str* и *context: NavigationContext*, и передаёт контекст запроса на переключение окон, состоящий из строкового названия окна и ссылки на класс окна (и возможно объекта класса окна). В свою очередь, датакласс *NavigationContext* состоит из одного поля *data*, которое хранит контекст окна.
Переключение между окнами осуществляется через программный интерфейс класса композитора, ссылку на объект которого по умолчанию додлжны получить все окна (Шаблон окна выше).
## Модуль Contrib
Модуль contrib содержит готовые реализации для типовых случаев.
В отличие от core, contrib контекстно зависим и предполагает
конкретные решения которые студент может использовать как есть
или взять за основу.
### Backends
Готовые реализации AbstractDatabase для трёх диалектов SQL:
```python
from pyqt6_scaffold.contrib import PostgresqlDatabase, MysqlDatabase, SqliteDatabase
```
Каждый backend читает конфигурацию из переменных окружения:
| Класс | Переменные окружения |
|--------------------|--------------------------------------------------------------------|
| PostgresqlDatabase | PG_HOST, PG_PORT, PG_USER, PG_DATABASE, PG_PASSWORD |
| MysqlDatabase | MYSQL_HOST, MYSQL_PORT, MYSQL_USER, MYSQL_DATABASE, MYSQL_PASSWORD |
| SqliteDatabase | SQLITE_PATH |
### Auth
Система авторизации на основе RBAC (Role-Based Access Control):
```python
from pyqt6_scaffold.contrib.auth import RBACMixin, Role, RoleLevel
```
**Role** и **RoleLevel** — датакласс и enum для описания ролей пользователя:
```python
from pyqt6_scaffold.contrib.auth import Role, RoleLevel
from pyqt6_scaffold import BaseUser
role = Role(name="Менеджер", level=RoleLevel.MANAGER.value)
user = BaseUser(id=1, name="Иван", role=role)
```
**RBACMixin** — миксин добавляющий метод `can()` в вашу базу данных.
Предполагает наличие таблицы `permission_map` в базе данных:
```sql
CREATE TABLE permission_map (
perm VARCHAR(50),
min_level INT
);
INSERT INTO permission_map VALUES ('edit.products', 50);
INSERT INTO permission_map VALUES ('delete.products', 100);
INSERT INTO permission_map VALUES ('view.products', 0);
...
```
Использование:
```python
from pyqt6_scaffold.contrib import MysqlDatabase
from pyqt6_scaffold.contrib.auth import RBACMixin
class AppDatabase(RBACMixin, MysqlDatabase):
def auth(self, login, password): ...
db = AppDatabase()
db.connect()
db.can(user, "edit.products") # True если user.role.level >= 50
db.can(user, "delete.products") # False если user.role.level < 100
```
Названия таблицы и полей можно переопределить:
```python
class AppDatabase(RBACMixin, MysqlDatabase):
permission_table = "rights"
permission_column = "action"
level_column = "required_level"
```

37
pyproject.toml Normal file
View file

@ -0,0 +1,37 @@
[build-system]
requires = ["setuptools>=68.0"]
build-backend = "setuptools.build_meta"
[project]
name = "pyqt6-scaffold"
version = "0.1.0"
description = "Lightweight scaffold framework for PyQt6 applications"
readme = "README.md"
requires-python = ">=3.11"
license = {file = "LICENSE"}
classifiers = [
"License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
"Topic :: Software Development :: User Interfaces",
"Topic :: Software Development :: Libraries :: Application Frameworks",
"Operating System :: OS Independent",
"Development Status :: 4 - Beta",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.11",
"Intended Audience :: Developers",
"Intended Audience :: Education",
]
authors = [
{ name = "Daniel Haus", email = "daniel.haus@protonmail.com" }
]
dependencies = [
"PyQt6>=6.5.0"
]
[project.optional-dependencies]
postgres = ["psycopg2-binary>=2.9.0"]
mysql = ["pymysql>=1.0.0"]
all = ["psycopg2-binary>=2.9.0", "pymysql>=1.0.0"]
[project.urls]
repository = "https://codeberg.org/zerumarex/pyqt6-scaffold"

34
pyqt6_scaffold/__init__.py Normal file
View file

@ -0,0 +1,34 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
from .core.composer import Composer
from .core.logging import setup_logger
from .core.database import CursorContext, AbstractDatabase
from .core.windows import BaseWindow
from .core.objects import (
BaseUser,
NavigationContext,
NavigateRequest
)
from .core.models import (
DataMixin,
BaseTableModel,
BaseListModel,
BaseCardModel
)
__version__ = "0.1.0"
__all__ = [
"BaseUser",
"NavigationContext",
"NavigateRequest",
"DataMixin",
"BaseTableModel",
"BaseListModel",
"BaseCardModel",
"BaseWindow",
"AbstractDatabase",
"CursorContext",
"setup_logger",
"Composer"
]

15
pyqt6_scaffold/contrib/__init__.py Normal file
View file

@ -0,0 +1,15 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
from .backends import (
MysqlDatabase,
SqliteDatabase,
PostgresqlDatabase,
)
from . import auth
__all__ = [
"auth",
"MysqlDatabase",
"SqliteDatabase",
"PostgresqlDatabase"
]

10
pyqt6_scaffold/contrib/auth/__init__.py Normal file
View file

@ -0,0 +1,10 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
from .role import Role, RoleLevel
from .database import RBACMixin
__all__ = [
"Role",
"RoleLevel",
"RBACMixin"
]

45
pyqt6_scaffold/contrib/auth/database.py Normal file
View file

@ -0,0 +1,45 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
from pyqt6_scaffold.core.objects import BaseUser
class RBACMixin:
"""
Role-Based Access Control mixin for AbstractDatabase subclasses.
Provides a can() method that checks user permissions against
a permission table in the database. Table and column names
are configurable as class attributes.
Expected table schema:
permission_table (permission_column, level_column)
Example:
permission_map (perm VARCHAR, min_level INT)
"""
permission_table: str = "permission_map"
permission_column: str = "perm"
level_column: str = "min_level"
def can(self, user: BaseUser, permission: str) -> bool:
"""
Check whether a user has the required permission level.
Args:
user: A BaseUser instance with a role.level attribute.
permission: Permission identifier to look up in the database.
Returns:
True if user.role.level >= required level, False otherwise.
"""
with self.execute(
f"""
SELECT {self.level_column}
FROM {self.permission_table}
WHERE {self.permission_column} = {self.placeholder}
""",
(permission,)
) as cursor:
row = cursor.fetchone()
if not row:
return False
return user.role.level >= row[0]

29
pyqt6_scaffold/contrib/auth/role.py Normal file
View file

@ -0,0 +1,29 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
from enum import Enum
from dataclasses import dataclass
@dataclass
class Role:
"""
Represents a user role with a hierarchical access level.
Attributes:
name: Human-readable role name.
level: Numeric access level used for permission checks.
"""
name: str
level: int
class RoleLevel(Enum):
"""
Predefined access levels for common roles.
Use these constants when populating the permission table
or comparing role levels in application logic.
"""
GUEST = 0
CLIENT = 25
EMPLOYEE = 50
MANAGER = 75
ADMIN = 100

87
pyqt6_scaffold/contrib/backends.py Normal file
View file

@ -0,0 +1,87 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
import os
from pyqt6_scaffold.core.logging import setup_logger
from pyqt6_scaffold.core.database import AbstractDatabase
log = setup_logger(__name__)
class PostgresqlDatabase(AbstractDatabase):
"""
AbstractDatabase implementation for PostgreSQL via psycopg2.
Configuration is read from environment variables:
PG_HOST, PG_PORT, PG_USER, PG_DATABASE, PG_PASSWORD
Requires:
pip install pyqt6-scaffold[postgres]
"""
@property
def placeholder(self) -> str:
return "%s"
def _connect(self):
try:
import psycopg2 as pg
except ImportError:
log.error("Ошибка импорта psycopg2")
raise
DB_CONFIG = {
"host": os.getenv("PG_HOST", "127.0.0.1"),
"port": int(os.getenv("PG_PORT", 5432)),
"user": os.getenv("PG_USER", "postgres"),
"database": os.getenv("PG_DATABASE", "postgres"),
"password": os.getenv("PG_PASSWORD", "postgres")
}
return pg.connect(**DB_CONFIG)
class MysqlDatabase(AbstractDatabase):
"""
AbstractDatabase implementation for MySQL via pymysql.
Configuration is read from environment variables:
MYSQL_HOST, MYSQL_PORT, MYSQL_USER, MYSQL_DATABASE, MYSQL_PASSWORD
Requires:
pip install pyqt6-scaffold[mysql]
"""
@property
def placeholder(self) -> str:
return "%s"
def _connect(self):
try:
import pymysql as pms
except ImportError:
log.error("Ошибка импорта pymysql")
raise
DB_CONFIG = {
"host": os.getenv("MYSQL_HOST", "localhost"),
"port": int(os.getenv("MYSQL_PORT", 3306)),
"user": os.getenv("MYSQL_USER", "root"),
"database": os.getenv("MYSQL_DATABASE", "root"),
"password": os.getenv("MYSQL_PASSWORD", "root")
}
return pms.connect(**DB_CONFIG)
class SqliteDatabase(AbstractDatabase):
"""
AbstractDatabase implementation for SQLite via the stdlib sqlite3 module.
Configuration is read from environment variables:
SQLITE_PATH (default: app.db)
No additional dependencies required.
"""
@property
def placeholder(self) -> str:
return "?"
def _connect(self):
import sqlite3
path = os.getenv("SQLITE_PATH", "app.db")
return sqlite3.connect(path)

1
pyqt6_scaffold/core/__init__.py Normal file
View file

@ -0,0 +1 @@
# SPDX-License-Identifier: LGPL-3.0-or-later

127
pyqt6_scaffold/core/composer.py Normal file
View file

@ -0,0 +1,127 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
from .objects import NavigateRequest
from .windows import BaseWindow
from .logging import setup_logger
from .database import AbstractDatabase
from PyQt6.QtWidgets import QApplication
from PyQt6.QtCore import QObject, pyqtSignal, pyqtSlot
from typing import Dict
log = setup_logger(__name__)
class Composer(QObject):
"""
Application router and window lifecycle manager.
Manages window registration, navigation between windows,
and holds the active database connection. Acts as the
central hub of the application.
Args:
app: QApplication instance.
db: Connected AbstractDatabase instance.
"""
navigate_request = pyqtSignal(NavigateRequest)
def __init__(self, app: QApplication, db: AbstractDatabase):
super().__init__()
self._db = db
self._current = None
self._app = app
self._registry: Dict[str, Dict[str, object]] = dict()
self._current_ctx: Dict[str, Dict[str, object]] = dict()
self.navigate_request.connect(self.navigate)
@property
def context(self):
"""
Return the current navigation context.
"""
return self._current_ctx
def register(self, name: str,
window: type[BaseWindow],
lazy: bool = True):
"""
Register a window class under a given name.
Args:
name: Unique string identifier for the window.
window: A subclass of BaseWindow.
lazy: If True, the window is instantiated on first navigation.
If False, the window is instantiated immediately.
Raises:
TypeError: If window is not a subclass of BaseWindow.
"""
if not issubclass(window, BaseWindow):
raise TypeError(f"{window} is not a descendant of BaseWindow")
entry = {
"class": window,
"instance": None,
"lazy": lazy
}
if not lazy:
entry["instance"] = window(self, self._db)
self._registry[name] = entry
def _switch_window(self, window):
"""
Close the current window and show the new one.
"""
if self._current:
self._current.close()
self._current = window
self._current.show()
def _create_window(self, name: str) -> BaseWindow:
"""
Instantiate or retrieve the window registered under name.
For lazy windows, creates a new instance on every call.
For eager windows, returns the existing instance.
"""
entry = self._registry[name]
if not entry["lazy"]:
return entry["instance"]
instance = entry["class"](self, self._db)
return instance
@pyqtSlot(NavigateRequest)
def navigate(self, request: NavigateRequest):
"""
Handle a NavigateRequest signal and switch to the target window.
Raises:
KeyError: If the target window is not registered.
"""
if request.target not in self._registry:
raise KeyError("Window is not registered")
self._current_ctx = request.context
window = self._create_window(request.target)
self._switch_window(window)
def run(self, start: str):
"""
Start the application from the given window.
Args:
start: Name of the window to show first.
Raises:
KeyError: If the start window is not registered.
"""
if start not in self._registry:
raise KeyError("Window is not registered")
window = self._create_window(start)
self._switch_window(window)
return self._app.exec()

171
pyqt6_scaffold/core/database.py Normal file
View file

@ -0,0 +1,171 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
from .logging import setup_logger
from abc import ABC, abstractmethod
log = setup_logger(__name__)
class CursorContext:
"""
Proxy wrapper around a database cursor.
Manages cursor lifecycle as a context manager and delegates
all attribute access to the underlying cursor object.
"""
def __init__(self, cursor):
self._cursor = cursor
def __enter__(self):
"""
Return the underlying cursor.
"""
return self._cursor
def __exit__(self, *args):
"""
Close the cursor on exit.
"""
self._cursor.close()
return False
def __getattr__(self, item):
return getattr(self._cursor, item)
def __iter__(self):
return iter(self._cursor)
def __next__(self):
return next(self._cursor)
class AbstractDatabase(ABC):
"""
Abstract base class for database connections.
Provides a unified interface for connecting, executing queries,
and managing transactions. Subclasses must implement _connect()
and placeholder.
Args:
strict: If True, raises RuntimeError when connect() is called
on an already open connection. If False, closes the
existing connection silently.
"""
def __init__(self, strict: bool = True):
self._conn = None
self._strict = strict
@abstractmethod
def _connect(self):
"""
Establish and return a database connection.
Must be implemented by subclasses. Read configuration from
environment variables or any other source, then return a
DB-API 2.0 compatible connection object.
Returns:
A database connection object.
"""
pass
def connect(self, *args, **kwargs):
"""
Open the database connection.
Calls _connect() internally. Should not be overridden.
Raises:
RuntimeError: If connection is already open and strict=True.
RuntimeError: If _connect() returns None.
"""
if self._conn is not None:
if self._strict:
raise RuntimeError("Database connection already open")
else:
try:
self._conn.close()
except Exception as e:
log.error(f"Query execution failed: {e}")
return None
conn = self._connect(*args, **kwargs)
if conn is None:
raise RuntimeError("_connect() must return a connection object")
self._conn = conn
return conn
def disconnect(self):
"""
Close the database connection and release resources.
"""
if self._conn is not None:
try:
self._conn.close()
finally:
self._conn = None
@property
def connection(self):
"""
Return the active connection object.
Raises:
RuntimeError: If the database is not connected.
"""
if self._conn is None:
raise RuntimeError("Database not connected")
return self._conn
@property
@abstractmethod
def placeholder(self) -> str:
"""
SQL parameter placeholder for the target dialect.
Must be implemented by subclasses.
"""
pass
def execute(self, sql: str, params: tuple = (), autocommit: bool = False) -> CursorContext | None:
"""
Execute a SQL query and return a CursorContext.
Args:
sql: SQL query string with placeholders.
params: Query parameters as a tuple.
autocommit: If True, commits the transaction after execution.
Returns:
CursorContext wrapping the cursor, or raises on failure.
Raises:
Exception: Re-raises any database error after rollback.
"""
cursor = self.connection.cursor()
try:
cursor.execute(sql, params)
if autocommit:
self.connection.commit()
return CursorContext(cursor)
except Exception:
self.connection.rollback()
log.exception("Query execution failed")
raise
def __enter__(self):
"""
Support use as a context manager for connection lifecycle.
Calls disconnect() on exit.
"""
return self
def __exit__(self, exc_type, exc_val, exc_tb):
"""
Support use as a context manager for connection lifecycle.
Calls disconnect() on exit.
"""
self.disconnect()

32
pyqt6_scaffold/core/logging.py Normal file
View file

@ -0,0 +1,32 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
import logging
def setup_logger(name: str = "scaffold"):
"""
Create and configure a logger with console output.
Returns an existing logger if one with the given name
already exists to avoid duplicate handlers.
Args:
name: Logger name, typically __name__.
Returns:
Configured logging.Logger instance.
"""
logger = logging.getLogger(name)
if logger.handlers:
return logger
formatter = logging.Formatter(
fmt="[%(asctime)s] %(levelname)-8s %(name)s: %(message)s",
datefmt="%H:%M:%S"
)
console = logging.StreamHandler()
console.setFormatter(formatter)
logger.addHandler(console)
return logger

248
pyqt6_scaffold/core/models.py Normal file
View file

@ -0,0 +1,248 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
from abc import ABC
from typing import List, Sequence, Any
from PyQt6.QtGui import QColor, QBrush, QFont
from PyQt6.QtCore import (
Qt,
QAbstractTableModel,
QAbstractListModel,
QModelIndex,
QVariant
)
class DataMixin(ABC):
"""
Mixin for Qt data models providing common data storage and display logic.
Intended to be used alongside QAbstractTableModel or QAbstractListModel.
The refresh() method relies on beginResetModel() and endResetModel()
provided by the Qt base class.
"""
def __init__(self):
super().__init__()
self._data: List[Sequence[Any]] = list()
def row_background(self, data: tuple) -> QColor | None:
"""
Return a background color for the given row, or None for default.
Override in subclass to apply conditional row highlighting.
Args:
data: The full row tuple from the dataset.
"""
pass
def row_foreground(self, data: tuple) -> QColor | None:
"""
Return a foreground (text) color for the given row, or None for default.
Override in subclass to apply conditional text coloring.
Args:
data: The full row tuple from the dataset.
"""
pass
def row_font(self, data: tuple) -> QFont | None:
"""
Return a QFont for the given row, or None for default.
Override in subclass to apply conditional font styling,
such as strikethrough or bold.
Args:
data: The full row tuple from the dataset.
"""
pass
def refresh(self, data: List[Sequence[Any]]):
"""
Replace the model data and notify the view.
Args:
data: New dataset as a list of sequences.
"""
self.beginResetModel()
self._data = data
self.endResetModel()
def row_data(self, row: int) -> tuple | None:
"""
Return the raw row tuple at the given index, or None if out of range.
"""
if 0 <= row < len(self._data):
return self._data[row]
return None
def row_display(self, data: Sequence[Any]):
"""
Return the string representation of a row for DisplayRole.
Override in subclass to customize how rows appear in the view.
Args:
data: The full row tuple from the dataset.
"""
return str(data[0]) if data else ""
class BaseTableModel(DataMixin, QAbstractTableModel):
"""
Table model backed by a list of row tuples.
Subclasses must define the headers class attribute.
Override row_display(), row_background(), row_foreground(),
and row_font() to customize cell appearance.
Attributes:
headers: Column header labels. Must be defined in subclass.
"""
# Column header labels displayed in the table view.
# Define this in your subclass: headers = ["ID", "Name", "Price"]
headers: List[str] = []
def rowCount(self, parent = QModelIndex()) -> int:
return len(self._data)
def columnCount(self, parent = QModelIndex()) -> int:
return len(self.headers)
def row_display(self, data):
"""
Return the string representation of a single cell value.
Args:
data: A single cell value from the dataset.
"""
return str(data) if data else ""
def data(self, index: QModelIndex, role = Qt.ItemDataRole.DisplayRole):
if not index.isValid():
return QVariant()
match role:
case Qt.ItemDataRole.DisplayRole:
value = self._data[index.row()][index.column()]
if value is not None:
return self.row_display(value)
else:
return ""
case Qt.ItemDataRole.UserRole:
return self._data[index.row()]
case Qt.ItemDataRole.BackgroundRole:
color = self.row_background(self._data[index.row()])
if color is None:
return QVariant()
brush = QBrush(color)
return brush
case Qt.ItemDataRole.ForegroundRole:
color = self.row_foreground(self._data[index.row()])
if color is None:
return QVariant()
brush = QBrush(color)
return brush
case Qt.ItemDataRole.FontRole:
font = self.row_font(self._data[index.row()])
if font is None:
return QVariant()
return font
return QVariant()
class BaseListModel(DataMixin, QAbstractListModel):
"""
List model backed by a list of row tuples.
Each row is treated as a single list item. DisplayRole
is rendered via row_display() which returns the first
element by default.
Override row_display() to customize how items appear in the view.
"""
def rowCount(self, parent = QModelIndex()) -> int:
return len(self._data)
def data(self, index: QModelIndex, role = Qt.ItemDataRole.DisplayRole):
if not index.isValid():
return QVariant()
match role:
case Qt.ItemDataRole.DisplayRole:
value = self._data[index.row()]
if value is not None:
return self.row_display(value)
return ""
case Qt.ItemDataRole.UserRole:
return self._data[index.row()]
case Qt.ItemDataRole.BackgroundRole:
color = self.row_background(self._data[index.row()])
if color is None:
return QVariant()
brush = QBrush(color)
return brush
case Qt.ItemDataRole.ForegroundRole:
color = self.row_foreground(self._data[index.row()])
if color is None:
return QVariant()
brush = QBrush(color)
return brush
case Qt.ItemDataRole.FontRole:
font = self.row_font(self._data[index.row()])
if font is None:
return QVariant()
return font
return QVariant()
class BaseCardModel(DataMixin, QAbstractListModel):
"""
List model for card-based views using a custom QStyledItemDelegate.
Does not implement DisplayRole — visual rendering is handled
entirely by a delegate. Raw row data is available via UserRole.
Note:
You must provide a QStyledItemDelegate subclass to render items.
Without a delegate, the view will appear empty.
"""
def rowCount(self, parent = QModelIndex()) -> int:
return len(self._data)
def data(self, index: QModelIndex, role = Qt.ItemDataRole.DisplayRole):
if not index.isValid():
return QVariant()
match role:
case Qt.ItemDataRole.UserRole:
return self._data[index.row()]
case Qt.ItemDataRole.BackgroundRole:
color = self.row_background(self._data[index.row()])
if color is None:
return QVariant()
brush = QBrush(color)
return brush
case Qt.ItemDataRole.ForegroundRole:
color = self.row_foreground(self._data[index.row()])
if color is None:
return QVariant()
brush = QBrush(color)
return brush
case Qt.ItemDataRole.FontRole:
font = self.row_font(self._data[index.row()])
if font is None:
return QVariant()
return font
return QVariant()

35
pyqt6_scaffold/core/objects.py Normal file
View file

@ -0,0 +1,35 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
from typing import Any, Dict
from dataclasses import dataclass, field
@dataclass
class BaseUser:
"""
Minimal user representation.
id and role are typed as Any to support different
authentication schemes (integer PK, UUID, custom role objects).
"""
id: Any
name: str
role: Any
@dataclass
class NavigationContext:
"""
Container for data passed between windows during navigation.
"""
data: Dict[str, Any] = field(default_factory=dict)
@dataclass
class NavigateRequest:
"""
Navigation event emitted by windows to request a screen transition.
Attributes:
target: Registered name of the destination window.
context: Data to pass to the destination window.
"""
target: str
context: NavigationContext

32
pyqt6_scaffold/core/windows.py Normal file
View file

@ -0,0 +1,32 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
from PyQt6.QtWidgets import QMainWindow
class BaseWindow(QMainWindow):
"""
Base class for all application windows.
Provides a structured initialization sequence through four
template methods that subclasses should override as needed.
The composer and database are available via self._composer
and self._db respectively.
_define_widgets: Create and initialize all widgets.
_tune_layouts: Arrange widgets into layouts.
_connect_slots: Connect signals to slots.
_apply_windows_settings: Set window title, size, icons, and other properties.
"""
def __init__(self, composer, db):
super().__init__()
self._db = db
self._composer = composer
self._define_widgets()
self._tune_layouts()
self._connect_slots()
self._apply_windows_settings()
def _define_widgets(self): pass
def _tune_layouts(self): pass
def _connect_slots(self): pass
def _apply_windows_settings(self): pass