Toerd@iArch
6 years ago
parent
fbfdf59d9b
commit
dedbe8341e
|
@ -0,0 +1,6 @@
|
||||
*.pyc
|
||||
*~
|
||||
MANIFEST
|
||||
dist
|
||||
build
|
||||
|
||||
@ -0,0 +1,18 @@
|
||||
|
||||
Jonathan BISSON <firstname.lastname at bjonnh.net> : initiator of the project
|
||||
Antti KAIHOLA <akaihol plus orgmode at ambitone dot com>
|
||||
m3wolf (github)
|
||||
bordercore (github)
|
||||
wroberts (github)
|
||||
gonvaled (github)
|
||||
10nin (github)
|
||||
CodeMonk (github)
|
||||
midraal (github)
|
||||
whacked (github)
|
||||
maxandersen (github)
|
||||
CodeMonk (github)
|
||||
midraal (github)
|
||||
Seamus Tuohy (@elationfoundation on github)
|
||||
clemente (github)
|
||||
kbarber2 (github)
|
||||
sp1ff (github)
|
||||
@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://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 <http://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
|
||||
<http://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
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
@ -0,0 +1,2 @@
|
||||
include LICENSE
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1 @@
|
||||
from .PyOrgMode import *
|
||||
@ -0,0 +1,10 @@
|
||||
* Test
|
||||
** Element 1
|
||||
SCHEDULED: <2011-02-08>
|
||||
** Element 2
|
||||
** Element 3
|
||||
DEADLINE: <2011-02-08>
|
||||
*** Test
|
||||
*** Element 4
|
||||
SCHEDULED: <2011-02-08>
|
||||
**** Couic
|
||||
@ -0,0 +1,3 @@
|
||||
* This is a headline
|
||||
**This is not a headline
|
||||
** This is a headline too
|
||||
@ -0,0 +1,7 @@
|
||||
This is an orgmode file with no headlines *test*
|
||||
|
||||
*Test*
|
||||
|
||||
edtedp
|
||||
|
||||
Test
|
||||
@ -0,0 +1,4 @@
|
||||
* First header :onetag:
|
||||
* TODO Second header :onetag:twotag:
|
||||
* TODO Third header :onetag:twotag:threetag:
|
||||
|
||||
@ -0,0 +1,42 @@
|
||||
|
||||
"""Tests for parsing and outputting a simple .org test file
|
||||
|
||||
You need the fr_FR.UTF-8 locale to run these tests
|
||||
"""
|
||||
|
||||
import locale
|
||||
import PyOrgMode
|
||||
try:
|
||||
import unittest2 as unittest
|
||||
except ImportError:
|
||||
import unittest
|
||||
|
||||
|
||||
def _normalize_ignored(line):
|
||||
"""Normalize a line to ignore differences which aren't yet handled"""
|
||||
line = line.replace(':ORDERED: t', ':ORDERED: t')
|
||||
return line
|
||||
|
||||
|
||||
def _normalize_output_ignored(line):
|
||||
line = line.replace(':TAG1:TAG2:', ':TAG1::TAG2:')
|
||||
line = _normalize_ignored(line)
|
||||
return line
|
||||
|
||||
|
||||
class TestExampleOrgFile(unittest.TestCase):
|
||||
def test_test_org(self):
|
||||
test = PyOrgMode.OrgDataStructure()
|
||||
locale.setlocale(locale.LC_ALL, 'fr_FR.UTF-8')
|
||||
test.load_from_file("test.org")
|
||||
test.save_to_file("output.org")
|
||||
with open("test.org") as f:
|
||||
original = [_normalize_ignored(line) for line in f]
|
||||
with open("output.org") as f:
|
||||
saved = [_normalize_output_ignored(line) for line in f]
|
||||
|
||||
self.assertEqual(saved, original)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
@ -0,0 +1,18 @@
|
||||
import PyOrgMode
|
||||
import unittest
|
||||
|
||||
|
||||
class TestClockElement(unittest.TestCase):
|
||||
def test_duration_format(self):
|
||||
"""Durations are formatted identically to org-mode"""
|
||||
|
||||
for hour in '0', '1', '5', '10', '12', '13', '19', '23':
|
||||
for minute in '00', '01', '29', '40', '59':
|
||||
orig_str = '%s:%s' % (hour, minute)
|
||||
orgdate_element = PyOrgMode.OrgDate(orig_str)
|
||||
formatted_str = orgdate_element.get_value()
|
||||
self.assertEqual(formatted_str, orig_str)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
@ -0,0 +1,85 @@
|
||||
|
||||
import PyOrgMode
|
||||
import unittest
|
||||
|
||||
|
||||
class TestDates(unittest.TestCase):
|
||||
"""Test the org file parser with several date formats"""
|
||||
|
||||
def test_baredate(self):
|
||||
"""
|
||||
Tests parsing dates without time.
|
||||
"""
|
||||
datestr = '<2013-11-20 Wed>'
|
||||
date = PyOrgMode.OrgDate(datestr)
|
||||
self.assertEqual(tuple(date.value), (2013, 11, 20, 0, 0, 0, 2, 324, -1))
|
||||
self.assertEqual(date.get_value(), datestr)
|
||||
|
||||
def test_datetime(self):
|
||||
"""
|
||||
Tests parsing dates with time.
|
||||
"""
|
||||
datestr = '<2011-12-12 Mon 09:00>'
|
||||
date = PyOrgMode.OrgDate(datestr)
|
||||
self.assertEqual(tuple(date.value), (2011, 12, 12, 9, 0, 0, 0, 346, -1))
|
||||
self.assertEqual(date.get_value(), datestr)
|
||||
|
||||
def test_datenoweekday(self):
|
||||
"""
|
||||
Tests parsing simple dates without weekdays.
|
||||
"""
|
||||
datestr = '<2013-11-20>'
|
||||
date = PyOrgMode.OrgDate(datestr)
|
||||
self.assertEqual(tuple(date.value), (2013, 11, 20, 0, 0, 0, 2, 324, -1))
|
||||
self.assertEqual(date.get_value(), datestr)
|
||||
|
||||
def test_localizeddatetime_unicode(self):
|
||||
"""
|
||||
Tests parsing dates with localized weekday name that uses non-ASCII.
|
||||
"""
|
||||
datestr = '<2011-12-12 Пнд 09:00>' # Понедельник = Monday (Russian)
|
||||
date = PyOrgMode.OrgDate(datestr)
|
||||
self.assertEqual(tuple(date.value), (2011, 12, 12, 9, 0, 0, 0, 346, -1))
|
||||
self.assertEqual(date.get_value(), '<2011-12-12 Mon 09:00>')
|
||||
|
||||
def test_localizeddatetime_dot(self):
|
||||
"""
|
||||
Tests parsing dates with localized weekday name that includes a dot.
|
||||
"""
|
||||
datestr = '<2011-12-12 al. 09:00>' # astelehena = Monday (Basque)
|
||||
date = PyOrgMode.OrgDate(datestr)
|
||||
self.assertEqual(tuple(date.value), (2011, 12, 12, 9, 0, 0, 0, 346, -1))
|
||||
self.assertEqual(date.get_value(), '<2011-12-12 Mon 09:00>')
|
||||
|
||||
def test_timerange(self):
|
||||
"""
|
||||
Tests parsing time ranges on the same day.
|
||||
"""
|
||||
datestr = '<2012-06-28 Thu 12:00-13:00>'
|
||||
date = PyOrgMode.OrgDate(datestr)
|
||||
self.assertEqual(tuple(date.value), (2012, 6, 28, 12, 0, 0, 3, 180, -1))
|
||||
self.assertEqual(tuple(date.end), (2012, 6, 28, 13, 0, 0, 3, 180, -1))
|
||||
self.assertEqual(date.get_value(), datestr)
|
||||
|
||||
def test_daterange(self):
|
||||
"""
|
||||
Tests parsing date ranges.
|
||||
"""
|
||||
datestr = '<2012-07-20 Fri>--<2012-07-31 Tue>'
|
||||
date = PyOrgMode.OrgDate(datestr)
|
||||
self.assertEqual(tuple(date.value), (2012, 7, 20, 0, 0, 0, 4, 202, -1))
|
||||
self.assertEqual(tuple(date.end), (2012, 7, 31, 0, 0, 0, 1, 213, -1))
|
||||
self.assertEqual(date.get_value(), datestr)
|
||||
|
||||
def test_daterangewithtimes(self):
|
||||
"""
|
||||
Tests parsing date ranges with times.
|
||||
"""
|
||||
datestr = '<2012-07-20 Fri 09:00>--<2012-07-31 Tue 14:00>'
|
||||
date = PyOrgMode.OrgDate(datestr)
|
||||
self.assertEqual(tuple(date.value), (2012, 7, 20, 9, 0, 0, 4, 202, -1))
|
||||
self.assertEqual(tuple(date.end), (2012, 7, 31, 14, 0, 0, 1, 213, -1))
|
||||
self.assertEqual(date.get_value(), datestr)
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
@ -0,0 +1,41 @@
|
||||
|
||||
"""Tests for headline validity
|
||||
"""
|
||||
|
||||
import PyOrgMode
|
||||
try:
|
||||
import unittest2 as unittest
|
||||
except ImportError:
|
||||
import unittest
|
||||
|
||||
|
||||
class TestHeadlineValidity(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.tree = PyOrgMode.OrgDataStructure()
|
||||
self.tree.add_todo_state('TODO')
|
||||
self.tree.load_from_file("headlines.org")
|
||||
self.todolist = self.tree.extract_todo_list()
|
||||
|
||||
def test_recognize_heading(self):
|
||||
"""The file has three top-level headings"""
|
||||
node = self.tree.root.content[0]
|
||||
self.assertIsInstance(node.content[1],
|
||||
PyOrgMode.OrgNode.Element)
|
||||
|
||||
def test_not_recognize_starredtext_asheading(self):
|
||||
"""The file has three top-level headings"""
|
||||
node = self.tree.root.content[0]
|
||||
self.assertNotIsInstance(node.content[0],
|
||||
PyOrgMode.OrgNode.Element)
|
||||
|
||||
def test_links_in_headline(self):
|
||||
"""Links and priorities are distinguished in headlines"""
|
||||
link = '[[http://github.com][Github]]'
|
||||
tree = PyOrgMode.OrgDataStructure()
|
||||
tree.load_from_string('* ' + link + ' :tag:')
|
||||
node = tree.root.content[0]
|
||||
self.assertTrue(node.heading.rstrip() == link)
|
||||
self.assertTrue('tag' in node.tags)
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
@ -0,0 +1,30 @@
|
||||
|
||||
"""Tests for parsing a file containing no headline
|
||||
but that contains a bold element (thanks whacked)
|
||||
You need the fr_FR.UTF-8 locale to run these tests
|
||||
"""
|
||||
|
||||
import locale
|
||||
import PyOrgMode
|
||||
try:
|
||||
import unittest2 as unittest
|
||||
except ImportError:
|
||||
import unittest
|
||||
|
||||
|
||||
class TestExampleOrgFile(unittest.TestCase):
|
||||
def test_noheadline_org(self):
|
||||
test = PyOrgMode.OrgDataStructure()
|
||||
test.load_from_file("no_headline.org")
|
||||
|
||||
locale.setlocale(locale.LC_ALL, 'fr_FR.UTF-8')
|
||||
test.save_to_file("output.org")
|
||||
with open("no_headline.org") as f:
|
||||
original = [line for line in f]
|
||||
with open("output.org") as f:
|
||||
saved = [line for line in f]
|
||||
self.assertEqual(saved, original)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
@ -0,0 +1,36 @@
|
||||
|
||||
import PyOrgMode
|
||||
import tempfile
|
||||
import unittest
|
||||
|
||||
|
||||
class TestParser(unittest.TestCase):
|
||||
"""Test the org file parser with a simple org structure"""
|
||||
|
||||
def setUp(self):
|
||||
"""Parse the org structure from a temporary file"""
|
||||
orgfile = tempfile.NamedTemporaryFile()
|
||||
orgfile.write('\n'.join((
|
||||
'* one',
|
||||
'* two',
|
||||
'** two point one',
|
||||
'* three',
|
||||
'')).encode('UTF-8'))
|
||||
orgfile.flush()
|
||||
self.tree = PyOrgMode.OrgDataStructure()
|
||||
try:
|
||||
self.tree.load_from_file(orgfile.name)
|
||||
finally:
|
||||
orgfile.close()
|
||||
|
||||
def test_has_three_top_level_headings(self):
|
||||
"""The example has three top-level headings"""
|
||||
self.assertEqual(len(self.tree.root.content), 3)
|
||||
|
||||
def test_second_item_has_a_subheading(self):
|
||||
"""The second top-level heading has one subheading"""
|
||||
self.assertEqual(len(self.tree.root.content[1].content), 1)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
@ -0,0 +1,11 @@
|
||||
* Element 1
|
||||
SCHEDULED: <2011-02-08>
|
||||
* Element 3
|
||||
DEADLINE: <2011-02-08>
|
||||
** Test
|
||||
** Element 4
|
||||
SCHEDULED: <2011-02-08>
|
||||
*** Couic
|
||||
* Element 4
|
||||
SCHEDULED: <2011-02-08>
|
||||
** Couic
|
||||
@ -0,0 +1,58 @@
|
||||
import PyOrgMode
|
||||
import copy
|
||||
try:
|
||||
import unittest2 as unittest
|
||||
except ImportError:
|
||||
import unittest
|
||||
|
||||
|
||||
def Get_Scheduled_Elements(element, data=[]):
|
||||
"""Grab the data from all scheduled elements for all the tree defined by
|
||||
'element' recursively. Returns all the elements as an array.
|
||||
"""
|
||||
if hasattr(element, "content"):
|
||||
for child in element.content:
|
||||
if hasattr(child, "TYPE"):
|
||||
if child.TYPE == "SCHEDULE_ELEMENT":
|
||||
# This element is scheduled, we are creating a copy of it
|
||||
data.append(copy.deepcopy(child.parent))
|
||||
Get_Scheduled_Elements(child, data)
|
||||
return data
|
||||
|
||||
|
||||
class TestAgenda(unittest.TestCase):
|
||||
def test_agenda(self):
|
||||
# Creating the input and output files data structures
|
||||
input_file = PyOrgMode.OrgDataStructure()
|
||||
output_file = PyOrgMode.OrgDataStructure()
|
||||
|
||||
# Loading from agenda.org file
|
||||
input_file.load_from_file("agenda.org")
|
||||
|
||||
# Get the scheduled elements (those with SCHEDULE, DEADLINE in them,
|
||||
# not in the node name)
|
||||
scheduled_elements = Get_Scheduled_Elements(input_file.root)
|
||||
|
||||
# Assign these element to the root (reparent each elements recursively,
|
||||
# relevel them cleanly)
|
||||
output_file.root.append_clean(scheduled_elements)
|
||||
|
||||
output_file.save_to_file("test_scheduled_output.org")
|
||||
with open("test_scheduled_output.org") as f:
|
||||
saved = f.readlines()
|
||||
|
||||
self.assertEqual(saved, ['* Element 1\n',
|
||||
' SCHEDULED: <2011-02-08>\n',
|
||||
'* Element 3\n',
|
||||
' DEADLINE: <2011-02-08>\n',
|
||||
'** Test\n',
|
||||
'** Element 4\n',
|
||||
' SCHEDULED: <2011-02-08>\n',
|
||||
'*** Couic\n',
|
||||
'* Element 4\n',
|
||||
' SCHEDULED: <2011-02-08>\n',
|
||||
'** Couic\n'])
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
@ -0,0 +1,131 @@
|
||||
|
||||
"""Tests for parsing a file containing no headline
|
||||
but that contains a bold element (thanks whacked)
|
||||
You need the fr_FR.UTF-8 locale to run these tests
|
||||
"""
|
||||
|
||||
import PyOrgMode
|
||||
import re
|
||||
import tempfile
|
||||
try:
|
||||
import unittest2 as unittest
|
||||
except ImportError:
|
||||
import unittest
|
||||
|
||||
|
||||
class TestExampleOrgFile(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.tree = PyOrgMode.OrgDataStructure()
|
||||
self.tree.add_todo_state('TODO')
|
||||
self.tree.load_from_file("tags.org")
|
||||
self.todolist = self.tree.extract_todo_list()
|
||||
|
||||
def test_has_three_top_level_headings(self):
|
||||
"""The file has three top-level headings"""
|
||||
self.assertEqual(len(self.tree.root.content), 3)
|
||||
|
||||
def test_the_first_item_has_one_tag(self):
|
||||
node = self.tree.root.content[0]
|
||||
self.assertEqual(len(node.tags), 1)
|
||||
self.assertEqual(node.heading.strip(), "First header")
|
||||
|
||||
def test_the_second_item_has_two_tags(self):
|
||||
"""The file has three top-level headings"""
|
||||
node = self.tree.root.content[1]
|
||||
|
||||
self.assertEqual(len(node.tags), 2)
|
||||
self.assertEqual(node.tags, ["onetag", "twotag"])
|
||||
self.assertEqual(node.heading.strip(), "Second header")
|
||||
|
||||
def test_third_item_has_three_tags(self):
|
||||
"""The file has three top-level headings"""
|
||||
node = self.tree.root.content[2]
|
||||
self.assertEqual(len(node.tags), 3)
|
||||
self.assertEqual(node.heading.strip(), "Third header")
|
||||
self.assertEqual(node.output(), "* TODO Third header " +
|
||||
" :onetag:twotag:threetag:\n\n")
|
||||
|
||||
|
||||
class TestTagInheritance(unittest.TestCase):
|
||||
def setUp(self):
|
||||
"""Setup a temp file against which to test."""
|
||||
orgfile = tempfile.NamedTemporaryFile()
|
||||
orgfile.write("""#+TITLE: test
|
||||
#+FILETAGS: :a:b:c:
|
||||
* one
|
||||
* two
|
||||
** TODO 2.1
|
||||
* three
|
||||
""".encode('UTF-8'))
|
||||
orgfile.flush()
|
||||
self.tree = PyOrgMode.OrgDataStructure()
|
||||
try:
|
||||
self.tree.load_from_file(orgfile.name)
|
||||
finally:
|
||||
orgfile.close()
|
||||
|
||||
def test_file_tags(self):
|
||||
assert self.tree.root.tags == ['a', 'b', 'c']
|
||||
todos = self.tree.extract_todo_list()
|
||||
assert len(todos) == 1 and '2.1' == todos[0].heading
|
||||
assert todos[0].node.get_all_tags() == ['a', 'b', 'c']
|
||||
assert todos[0].node.get_all_tags(None) == []
|
||||
assert todos[0].node.get_all_tags(True, ['a']) == ['b', 'c']
|
||||
assert todos[0].node.get_all_tags(re.compile('[ab]')) == ['a', 'b']
|
||||
|
||||
|
||||
class TestFileTagsPlugin(unittest.TestCase):
|
||||
|
||||
def test_filetags1(self):
|
||||
tree = PyOrgMode.OrgDataStructure()
|
||||
tree.load_from_string("""#+TITLE: test
|
||||
#+FILETAGS: :a:b:c:
|
||||
* one
|
||||
* two
|
||||
* three
|
||||
""")
|
||||
assert tree.root.tags == ['a', 'b', 'c']
|
||||
|
||||
def test_filetags2(self):
|
||||
tree = PyOrgMode.OrgDataStructure()
|
||||
tree.load_from_string("""#+TITLE: test
|
||||
#+FILETAGS: a:b:c:
|
||||
* one
|
||||
* two
|
||||
* three
|
||||
""")
|
||||
assert tree.root.tags == ['a', 'b', 'c']
|
||||
|
||||
def test_filetags3(self):
|
||||
tree = PyOrgMode.OrgDataStructure()
|
||||
tree.load_from_string("""#+TITLE: test
|
||||
#+FILETAGS: a:b:c
|
||||
* one
|
||||
* two
|
||||
* three
|
||||
""")
|
||||
assert tree.root.tags == ['a', 'b', 'c']
|
||||
|
||||
def test_filetags4(self):
|
||||
tree = PyOrgMode.OrgDataStructure()
|
||||
tree.load_from_string("""#+TITLE: test
|
||||
#+FILETAGS: a:b
|
||||
* one
|
||||
* two
|
||||
* three
|
||||
""")
|
||||
assert tree.root.tags == ['a', 'b']
|
||||
|
||||
def test_filetags5(self):
|
||||
tree = PyOrgMode.OrgDataStructure()
|
||||
tree.load_from_string("""#+TITLE: test
|
||||
#+FILETAGS: a
|
||||
* one
|
||||
* two
|
||||
* three
|
||||
""")
|
||||
assert tree.root.tags == ['a']
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
@ -0,0 +1,747 @@
|
||||
# -*- encoding: utf-8 -*-
|
||||
##############################################################################
|
||||
#
|
||||
# PyOrgMode, a python module for treating with orgfiles
|
||||
# Copyright (C) 2010 Jonathan BISSON (bissonjonathan on the google thing).
|
||||
# All Rights Reserved
|
||||
#
|
||||
# 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 <http://www.gnu.org/licenses/>.
|
||||
#
|
||||
##############################################################################
|
||||
|
||||
"""
|
||||
The PyOrgMode class is able to read,modify and create orgfiles. The internal
|
||||
representation of the file allows the use of orgfiles easily in your projects.
|
||||
"""
|
||||
|
||||
import re
|
||||
import string
|
||||
import copy
|
||||
import time
|
||||
|
||||
class OrgDate:
|
||||
"""Functions for date management"""
|
||||
|
||||
format = 0
|
||||
TIMED = 1
|
||||
DATED = 2
|
||||
WEEKDAYED = 4
|
||||
ACTIVE = 8
|
||||
INACTIVE = 16
|
||||
RANGED = 32
|
||||
REPEAT = 64
|
||||
|
||||
# TODO: Timestamp with repeater interval
|
||||
DICT_RE = {'start': '[[<]',
|
||||
'end': '[]>]',
|
||||
'date': '([0-9]{4})-([0-9]{2})-([0-9]{2})(\s+([\w]+))?',
|
||||
'time': '([0-9]{2}):([0-9]{2})',
|
||||
'repeat': '[\+\.]{1,2}\d+[dwmy]'}
|
||||
|
||||
def __init__(self,value=None):
|
||||
"""
|
||||
Initialisation of an OrgDate element.
|
||||
"""
|
||||
if value != None:
|
||||
self.set_value(value)
|
||||
|
||||
def parse_datetime(self, s):
|
||||
"""
|
||||
Parses an org-mode date time string.
|
||||
Returns (timed, weekdayed, time_struct, repeat).
|
||||
"""
|
||||
search_re = '(?P<date>{date})(\s+(?P<time>{time}))?'.format(
|
||||
**self.DICT_RE)
|
||||
s = re.search(search_re, s)
|
||||
weekdayed = (len(s.group('date').split()) > 1)
|
||||
if s.group('time'):
|
||||
return (True,
|
||||
weekdayed,
|
||||
time.strptime(
|
||||
s.group('date').split()[0] + ' ' + s.group('time'),
|
||||
'%Y-%m-%d %H:%M'))
|
||||
else:
|
||||
return (False,
|
||||
weekdayed,
|
||||
time.strptime(s.group('date').split()[0], '%Y-%m-%d'))
|
||||
|
||||
def set_value(self,value):
|
||||
"""
|
||||
Setting the value of this element (automatic recognition of format)
|
||||
"""
|
||||
# Checking whether it is an active date-time or not
|
||||
if value[0] == '<':
|
||||
self.format |= self.ACTIVE
|
||||
elif value[0] == '[':
|
||||
self.format |= self.INACTIVE
|
||||
|
||||
# time range on a single day
|
||||
search_re = ('{start}(?P<date>{date})\s+(?P<time1>{time})'
|
||||
'-(?P<time2>{time}){end}').format(**self.DICT_RE)
|
||||
match = re.search(search_re, value)
|
||||
if match:
|
||||
#timed, weekdayed, date = self.parse_datetime(match.group('date'))
|
||||
#self.value = time.strptime(match.group('time1').split()[0], '%H:%M')
|
||||
#self.value = time.struct_time(date[:3] + self.value[3:])
|
||||
timed, weekdayed, self.value = self.parse_datetime(
|
||||
match.group('date') + ' ' + match.group('time1'))
|
||||
if weekdayed:
|
||||
self.format |= self.WEEKDAYED
|
||||
timed, weekdayed, self.end = self.parse_datetime(
|
||||
match.group('date') + ' ' + match.group('time2'))
|
||||
#self.end = time.strptime(match.group('time2').split()[0], '%H:%M')
|
||||
#self.end = time.struct_time(date[:3] + self.end[3:])
|
||||
self.format |= self.TIMED | self.DATED | self.RANGED
|
||||
return
|
||||
# date range over several days
|
||||
search_re = ('{start}(?P<date1>{date}(\s+{time})?){end}--'
|
||||
'{start}(?P<date2>{date}(\s+{time})?){end}').format(
|
||||
**self.DICT_RE)
|
||||
match = re.search(search_re, value)
|
||||
if match:
|
||||
timed, weekdayed, self.value = self.parse_datetime(
|
||||
match.group('date1'))
|
||||
if timed:
|
||||
self.format |= self.TIMED
|
||||
if weekdayed:
|
||||
self.format |= self.WEEKDAYED
|
||||
timed, weekdayed, self.end = self.parse_datetime(
|
||||
match.group('date2'))
|
||||
self.format |= self.DATED | self.RANGED
|
||||
return
|
||||
# single date with no range
|
||||
search_re = '{start}(?P<datetime>{date}(\s+{time})?)(\s+(?P<repeat>{repeat}))?{end}'.format(**self.DICT_RE)
|
||||
match = re.search(search_re, value)
|
||||
if match:
|
||||
timed, weekdayed, self.value = self.parse_datetime(
|
||||
match.group('datetime'))
|
||||
if match.group('repeat'):
|
||||
self.repeat = match.group('repeat')
|
||||
self.format |= self.REPEAT
|
||||
self.format |= self.DATED
|
||||
if timed:
|
||||
self.format |= self.TIMED
|
||||
if weekdayed:
|
||||
self.format |= self.WEEKDAYED
|
||||
self.end = None
|
||||
|
||||
def get_value(self):
|
||||
"""
|
||||
Get the timestamp as a text according to the format
|
||||
"""
|
||||
fmt_dict = {'time': '%H:%M'}
|
||||
if self.format & self.ACTIVE:
|
||||
fmt_dict['start'], fmt_dict['end'] = '<', '>'
|
||||
else:
|
||||
fmt_dict['start'], fmt_dict['end'] = '[', ']'
|
||||
if self.format & self.WEEKDAYED:
|
||||
fmt_dict['date'] = '%Y-%m-%d %a'
|
||||
else:
|
||||
fmt_dict['date'] = '%Y-%m-%d'
|
||||
if self.format & self.RANGED:
|
||||
if self.value[:3] == self.end[:3]:
|
||||
# range is between two times on a single day
|
||||
assert self.format & self.TIMED
|
||||
return (time.strftime(
|
||||
'{start}{date} {time}-'.format(**fmt_dict), self.value) +
|
||||
time.strftime('{time}{end}'.format(**fmt_dict),
|
||||
self.end))
|
||||
else:
|
||||
# range is between two days
|
||||
if self.format & self.TIMED:
|
||||
return (time.strftime(
|
||||
'{start}{date} {time}{end}--'.format(**fmt_dict),
|
||||
self.value) +
|
||||
time.strftime(
|
||||
'{start}{date} {time}{end}'.format(**fmt_dict),
|
||||
self.end))
|
||||
else:
|
||||
return (time.strftime(
|
||||
'{start}{date}{end}--'.format(**fmt_dict), self.value) +
|
||||
time.strftime(
|
||||
'{start}{date}{end}'.format(**fmt_dict),
|
||||
self.end))
|
||||
else: # non-ranged time
|
||||
# Repeated
|
||||
if self.format & self.REPEAT:
|
||||
fmt_dict['repeat'] = ' ' + self.repeat
|
||||
else:
|
||||
fmt_dict['repeat'] = ''
|
||||
if self.format & self.TIMED:
|
||||
return time.strftime(
|
||||
'{start}{date} {time}{repeat}{end}'.format(**fmt_dict), self.value)
|
||||
else:
|
||||
return time.strftime(
|
||||
'{start}{date}{repeat}{end}'.format(**fmt_dict), self.value)
|
||||
|
||||
class OrgPlugin:
|
||||
"""
|
||||
Generic class for all plugins
|
||||
"""
|
||||
def __init__(self):
|
||||
""" Generic initialization """
|
||||
self.treated = True
|
||||
self.keepindent = True # By default, the plugin system stores the indentation before the treatment
|
||||
self.keepindent_value = ""
|
||||
|
||||
def treat(self,current,line):
|
||||
""" This is a wrapper function for _treat. Asks the plugin if he can manage this kind of line. Returns True if it can """
|
||||
self.treated = True
|
||||
if self.keepindent :
|
||||
self.keepindent_value = line[0:len(line)-len(line.lstrip(" \t"))] # Keep a trace of the indentation
|
||||
return self._treat(current,line.lstrip(" \t"))
|
||||
else:
|
||||
return self._treat(current,line)
|
||||
|
||||
def _treat(self,current,line):
|
||||
""" This is the function used by the plugin for the management of the line. """
|
||||
self.treated = False
|
||||
return current
|
||||
|
||||
def _append(self,current,element):
|
||||
""" Internal function that adds to current. """
|
||||
if self.keepindent and hasattr(element,"set_indent"):
|
||||
element.set_indent(self.keepindent_value)
|
||||
return current.append(element)
|
||||
|
||||
def close(self,current):
|
||||
""" A wrapper function for closing the module. """
|
||||
self.treated = False
|
||||
return self._close(current)
|
||||
def _close(self,current):
|
||||
""" This is the function used by the plugin to close everything that have been opened. """
|
||||
self.treated = False
|
||||
return current
|
||||
|
||||
class OrgElement:
|
||||
"""
|
||||
Generic class for all Elements excepted text and unrecognized ones
|
||||
"""
|
||||
def __init__(self):
|
||||
self.content=[]
|
||||
self.parent=None
|
||||
self.level=0
|
||||
self.indent = ""
|
||||
|
||||
def append(self,element):
|
||||
# TODO Check validity
|
||||
self.content.append(element)
|
||||
# Check if the element got a parent attribute
|
||||
# If so, we can have childrens into this element
|
||||
if hasattr(element,"parent"):
|
||||
element.parent = self
|
||||
return element
|
||||
|
||||
def set_indent(self,indent):
|
||||
""" Transfer the indentation from plugin to element. """
|
||||
self.indent = indent
|
||||
|
||||
def output(self):
|
||||
""" Wrapper for the text output. """
|
||||
return self.indent+self._output()
|
||||
def _output(self):
|
||||
""" This is the function really used by the plugin. """
|
||||
return ""
|
||||
|
||||
def __str__(self):
|
||||
""" Used to return a text when called. """
|
||||
return self.output()
|
||||
|
||||
class OrgTodo():
|
||||
"""Describes an individual TODO item for use in agendas and TODO lists"""
|
||||
def __init__(self, heading, todo_state,
|
||||
scheduled=None, deadline=None,
|
||||
tags=None, priority=None,
|
||||
path=[0]
|
||||
):
|
||||
self.heading = heading
|
||||
self.todo_state = todo_state
|
||||
self.scheduled = scheduled
|
||||
self.deadline = deadline
|
||||
self.tags = tags
|
||||
self.priority = priority
|
||||
def __str__(self):
|
||||
string = self.todo_state + " " + self.heading
|
||||
return string
|
||||
|
||||
class OrgClock(OrgPlugin):
|
||||
"""Plugin for Clock elements"""
|
||||
def __init__(self):
|
||||
OrgPlugin.__init__(self)
|
||||
self.regexp = re.compile("(?:\s*)CLOCK:(?:\s*)((?:<|\[).*(?:>||\]))--((?:<|\[).*(?:>||\])).*=>\s*(.*)")
|
||||
def _treat(self,current,line):
|
||||
clocked = self.regexp.findall(line)
|
||||
if clocked:
|
||||
self._append(current,self.Element(clocked[0][0], clocked[0][1], clocked[0][2]))
|
||||
else:
|
||||
self.treated = False
|
||||
return current
|
||||
|
||||
class Element(OrgElement):
|
||||
"""Clock is an element taking into account CLOCK elements"""
|
||||
TYPE = "CLOCK_ELEMENT"
|
||||
def __init__(self,start="",stop="",duration=""):
|
||||
OrgElement.__init__(self)
|
||||
self.start = OrgDate(start)
|
||||
self.stop = OrgDate(stop)
|
||||
self.duration = OrgDate(duration)
|
||||
def _output(self):
|
||||
"""Outputs the Clock element in text format (e.g CLOCK: [2010-11-20 Sun 19:42]--[2010-11-20 Sun 20:14] => 0:32)"""
|
||||
return "CLOCK: " + self.start.get_value() + "--"+ self.stop.get_value() + " => "+self.duration.get_value()+"\n"
|
||||
|
||||
class OrgSchedule(OrgPlugin):
|
||||
"""Plugin for Schedule elements"""
|
||||
# TODO: Need to find a better way to do this
|
||||
def __init__(self):
|
||||
OrgPlugin.__init__(self)
|
||||
|
||||
self.regexp_scheduled = re.compile("SCHEDULED: ((<|\[).*?(>|\])(--(<|\[).*?(>|\]))?)")
|
||||
self.regexp_deadline = re.compile("DEADLINE: ((<|\[).*?(>|\])(--(<|\[).*?(>|\]))?)")
|
||||
self.regexp_closed = re.compile("CLOSED: ((<|\[).*?(>|\])(--(<|\[).*?(>|\]))?)")
|
||||
def _treat(self,current,line):
|
||||
scheduled = self.regexp_scheduled.findall(line)
|
||||
deadline = self.regexp_deadline.findall(line)
|
||||
closed = self.regexp_closed.findall(line)
|
||||
|
||||
if scheduled != []:
|
||||
scheduled = scheduled[0][0]
|
||||
if closed != []:
|
||||
closed = closed[0][0]
|
||||
if deadline != []:
|
||||
deadline = deadline[0][0]
|
||||
|
||||
if scheduled or deadline or closed:
|
||||
self._append(current,self.Element(scheduled, deadline,closed))
|
||||
else:
|
||||
self.treated = False
|
||||
return current
|
||||
|
||||
class Element(OrgElement):
|
||||
"""Schedule is an element taking into account DEADLINE, SCHEDULED and CLOSED parameters of elements"""
|
||||
DEADLINE = 1
|
||||
SCHEDULED = 2
|
||||
CLOSED = 4
|
||||
TYPE = "SCHEDULE_ELEMENT"
|
||||
def __init__(self,scheduled=[],deadline=[],closed=[]):
|
||||
OrgElement.__init__(self)
|
||||
self.type = 0
|
||||
|
||||
if scheduled != []:
|
||||
self.type = self.type | self.SCHEDULED
|
||||
self.scheduled = OrgDate(scheduled)
|
||||
if deadline != []:
|
||||
self.type = self.type | self.DEADLINE
|
||||
self.deadline = OrgDate(deadline)
|
||||
if closed != []:
|
||||
self.type = self.type | self.CLOSED
|
||||
self.closed = OrgDate(closed)
|
||||
|
||||
def _output(self):
|
||||
"""Outputs the Schedule element in text format (e.g SCHEDULED: <2010-10-10 10:10>)"""
|
||||
output = ""
|
||||
if self.type & self.SCHEDULED:
|
||||
output = output + "SCHEDULED: "+self.scheduled.get_value()+" "
|
||||
if self.type & self.DEADLINE:
|
||||
output = output + "DEADLINE: "+self.deadline.get_value()+" "
|
||||
if self.type & self.CLOSED:
|
||||
output = output + "CLOSED: "+self.closed.get_value()+" "
|
||||
if output != "":
|
||||
output = output.rstrip() + "\n"
|
||||
return output
|
||||
|
||||
class OrgDrawer(OrgPlugin):
|
||||
"""A Plugin for drawers"""
|
||||
def __init__(self):
|
||||
OrgPlugin.__init__(self)
|
||||
self.regexp = re.compile("^(?:\s*?)(?::)(\S.*?)(?::)\s*(.*?)$")
|
||||
def _treat(self,current,line):
|
||||
drawer = self.regexp.search(line)
|
||||
if isinstance(current, OrgDrawer.Element): # We are in a drawer
|
||||
if drawer:
|
||||
if drawer.group(1) == "END": # Ending drawer
|
||||
current = current.parent
|
||||
elif drawer.group(2): # Adding a property
|
||||
self._append(current,self.Property(drawer.group(1),drawer.group(2)))
|
||||
else: # Adding text in drawer
|
||||
self._append(current,line.rstrip("\n"))
|
||||
elif drawer: # Creating a drawer
|
||||
current = self._append(current,OrgDrawer.Element(drawer.group(1)))
|
||||
else:
|
||||
self.treated = False
|
||||
return current
|
||||
return current # It is a drawer, change the current also (even if not modified)
|
||||
|
||||
class Element(OrgElement):
|
||||
"""A Drawer object, containing properties and text"""
|
||||
TYPE = "DRAWER_ELEMENT"
|
||||
def __init__(self,name=""):
|
||||
OrgElement.__init__(self)
|
||||
self.name = name
|
||||
def _output(self):
|
||||
output = ":" + self.name + ":\n"
|
||||
for element in self.content:
|
||||
output = output + str(element) + "\n"
|
||||
output = output + self.indent + ":END:\n"
|
||||
return output
|
||||
class Property(OrgElement):
|
||||
"""A Property object, used in drawers."""
|
||||
def __init__(self,name="",value=""):
|
||||
OrgElement.__init__(self)
|
||||
self.name = name
|
||||
self.value = value
|
||||
def _output(self):
|
||||
"""Outputs the property in text format (e.g. :name: value)"""
|
||||
return ":" + self.name + ": " + self.value
|
||||
|
||||
class OrgTable(OrgPlugin):
|
||||
"""A plugin for table managment"""
|
||||
def __init__(self):
|
||||
OrgPlugin.__init__(self)
|
||||
self.regexp = re.compile("^\s*\|")
|
||||
def _treat(self,current,line):
|
||||
table = self.regexp.match(line)
|
||||
if table:
|
||||
if not isinstance(current,self.Element):
|
||||
current = current.append(self.Element())
|
||||
current.append(line.rstrip().strip("|").split("|"))
|
||||
else:
|
||||
if isinstance(current,self.Element):
|
||||
current = current.parent
|
||||
self.treated = False
|
||||
return current
|
||||
|
||||
class Element(OrgElement):
|
||||
"""
|
||||
A Table object
|
||||
"""
|
||||
TYPE = "TABLE_ELEMENT"
|
||||
def __init__(self):
|
||||
OrgElement.__init__(self)
|
||||
def _output(self):
|
||||
output = ""
|
||||
for element in self.content:
|
||||
output = output + "|"
|
||||
for cell in element:
|
||||
output = output + str(cell) + "|"
|
||||
output = output + "\n"
|
||||
return output
|
||||
|
||||
class OrgNode(OrgPlugin):
|
||||
def __init__(self):
|
||||
OrgPlugin.__init__(self)
|
||||
self.todo_list = ['TODO']
|
||||
self.done_list = ['DONE']
|
||||
self.keepindent = False # If the line starts by an indent, it is not a node
|
||||
def _treat(self,current,line):
|
||||
# Build regexp
|
||||
regexp_string = "^(\*+)\s*"
|
||||
if self.todo_list:
|
||||
separator = ""
|
||||
re_todos = "("
|
||||
for todo_keyword in self.todo_list + self.done_list:
|
||||
re_todos += separator
|
||||
separator = "|"
|
||||
re_todos += todo_keyword
|
||||
re_todos += ")?\s*"
|
||||
regexp_string += re_todos
|
||||
regexp_string += "(\[.*\])?\s*(.*)$"
|
||||
self.regexp = re.compile(regexp_string)
|
||||
heading = self.regexp.findall(line)
|
||||
if heading: # We have a heading
|
||||
|
||||
if current.parent :
|
||||
current.parent.append(current)
|
||||
|
||||
# Is that a new level ?
|
||||
if (len(heading[0][0]) > current.level): # Yes
|
||||
parent = current # Parent is now the current node
|
||||
else:
|
||||
parent = current.parent # If not, the parent of the current node is the parent
|
||||
# If we are going back one or more levels, walk through parents
|
||||
while len(heading[0][0]) < current.level:
|
||||
current = current.parent
|
||||
parent = current.parent
|
||||
# Creating a new node and assigning parameters
|
||||
current = OrgNode.Element()
|
||||
current.level = len(heading[0][0])
|
||||
current.heading = re.sub(":([\w]+):","",heading[0][3]) # Remove tags
|
||||
current.priority = heading[0][2].strip('[#]')
|
||||
current.parent = parent
|
||||
if heading[0][1]:
|
||||
current.todo = heading[0][1]
|
||||
|
||||
# Looking for tags
|
||||
heading_without_links = re.sub(" \[(.+)\]","",heading[0][3])
|
||||
current.tags = re.findall(":([\w]+):",heading_without_links)
|
||||
else:
|
||||
self.treated = False
|
||||
return current
|
||||
def _close(self,current):
|
||||
# Add the last node
|
||||
if current.level>0:
|
||||
current.parent.append(current)
|
||||
|
||||
class Element(OrgElement):
|
||||
# Defines an OrgMode Node in a structure
|
||||
# The ID is auto-generated using uuid.
|
||||
# The level 0 is the document itself
|
||||
TYPE = "NODE_ELEMENT"
|
||||
def __init__(self):
|
||||
OrgElement.__init__(self)
|
||||
self.content = []
|
||||
self.level = 0
|
||||
self.heading = ""
|
||||
self.priority = ""
|
||||
self.tags = []
|
||||
# TODO Scheduling structure
|
||||
|
||||
def _output(self):
|
||||
output = ""
|
||||
|
||||
if hasattr(self,"level"):
|
||||
output = output + "*"*self.level
|
||||
|
||||
if hasattr(self, "todo"):
|
||||
output = output + " " + self.todo
|
||||
|
||||
if self.parent is not None:
|
||||
output = output + " "
|
||||
if self.priority:
|
||||
output = output + "[#" + self.priority + "] "
|
||||
output = output + self.heading
|
||||
|
||||
for tag in self.tags:
|
||||
output= output + ":" + tag + ":"
|
||||
|
||||
output = output + "\n"
|
||||
|
||||
for element in self.content:
|
||||
output = output + element.__str__()
|
||||
|
||||
return output
|
||||
def append_clean(self,element):
|
||||
if isinstance(element,list):
|
||||
self.content.extend(element)
|
||||
else:
|
||||
self.content.append(element)
|
||||
self.reparent_cleanlevels(self)
|
||||
def reparent_cleanlevels(self,element=None,level=None):
|
||||
"""
|
||||
Reparent the childs elements of 'element' and make levels simpler.
|
||||
Useful after moving one tree to another place or another file.
|
||||
"""
|
||||
if element == None:
|
||||
element = self.root
|
||||
if hasattr(element,"level"):
|
||||
if level == None:
|
||||
level = element.level
|
||||
else:
|
||||
element.level = level
|
||||
|
||||
if hasattr(element,"content"):
|
||||
for child in element.content:
|
||||
if hasattr(child,"parent"):
|
||||
child.parent = element
|
||||
self.reparent_cleanlevels(child,level+1)
|
||||
|
||||
class OrgDataStructure(OrgElement):
|
||||
"""
|
||||
Data structure containing all the nodes
|
||||
The root property contains a reference to the level 0 node
|
||||
"""
|
||||
root = None
|
||||
TYPE = "DATASTRUCTURE_ELEMENT"
|
||||
def __init__(self):
|
||||
OrgElement.__init__(self)
|
||||
self.plugins = []
|
||||
self.load_plugins(OrgTable(),OrgDrawer(),OrgNode(),OrgSchedule(),OrgClock())
|
||||
# Add a root element
|
||||
# The root node is a special node (no parent) used as a container for the file
|
||||
self.root = OrgNode.Element()
|
||||
self.root.parent = None
|
||||
self.level = 0
|
||||
|
||||
def load_plugins(self,*arguments,**keywords):
|
||||
"""
|
||||
Used to load plugins inside this DataStructure
|
||||
"""
|
||||
for plugin in arguments:
|
||||
self.plugins.append(plugin)
|
||||
def set_todo_states(self,new_states):
|
||||
"""
|
||||
Used to override the default list of todo states for any
|
||||
OrgNode plugins in this object's plugins list. Expects
|
||||
a list[] of strings as its argument. The list can be split
|
||||
by '|' entries into TODO items and DONE items. Anything after
|
||||
a second '|' will not be processed and be returned.
|
||||
Setting to an empty list will disable TODO checking.
|
||||
"""
|
||||
new_todo_states = []
|
||||
new_done_states = []
|
||||
num_lists = 1
|
||||
# Process the first part of the list (delimited by '|')
|
||||
for new_state in new_states:
|
||||
if new_state == '|':
|
||||
num_lists += 1
|
||||
break
|
||||
new_todo_states.append(new_state)
|
||||
# Clean up the lists so far
|
||||
if num_lists > 1:
|
||||
new_states.remove('|')
|
||||
for todo_state in new_todo_states:
|
||||
new_states.remove(todo_state)
|
||||
# Process the second part of the list (delimited by '|')
|
||||
for new_state in new_states:
|
||||
if new_state == '|':
|
||||
num_lists += 1
|
||||
break
|
||||
new_done_states.append(new_state)
|
||||
# Clean up the second list
|
||||
if num_lists > 2:
|
||||
new_states.remove('|')
|
||||
for todo_state in new_done_states:
|
||||
new_states.remove(todo_state)
|
||||
# Write the relevant attributes
|
||||
for plugin in self.plugins:
|
||||
if plugin.__class__ == OrgNode:
|
||||
plugin.todo_list = new_todo_states
|
||||
plugin.done_list = new_done_states
|
||||
if new_states:
|
||||
return new_states # Return any leftovers
|
||||
def get_todo_states(self, list_type="todo"):
|
||||
"""
|
||||
Returns a list of todo states. An empty list means that
|
||||
instance of OrgNode has TODO checking disabled. The first argument
|
||||
determines the list that is pulled ("todo"*, "done" or "all").
|
||||
"""
|
||||
all_states = []
|
||||
for plugin in self.plugins:
|
||||
if plugin.__class__ == OrgNode:
|
||||
if plugin.todo_list and (list_type == "todo" or list_type == "all"):
|
||||
all_states += plugin.todo_list
|
||||
if plugin.done_list and (list_type == "done" or list_type == "all"):
|
||||
all_states += plugin.done_list
|
||||
return list(set(all_states))
|
||||
def add_todo_state(self, new_state):
|
||||
"""
|
||||
Appends a todo state to the list of todo states of any OrgNode
|
||||
plugins in this objects plugins list.
|
||||
Expects a string as its argument.
|
||||
"""
|
||||
for plugin in self.plugins:
|
||||
if plugin.__class__ == OrgNode:
|
||||
plugin.todo_list.append(new_state)
|
||||
def add_done_state(self, new_state):
|
||||
"""
|
||||
Appends a todo state to the list of todo states of any OrgNode
|
||||
plugins in this objects plugins list.
|
||||
Expects a string as its argument.
|
||||
"""
|
||||
for plugin in self.plugins:
|
||||
if plugin.__class__ == OrgNode:
|
||||
plugin.done_list.append(new_state)
|
||||
def remove_todo_state(self, old_state):
|
||||
"""
|
||||
Remove a given todo state from both the todo list and the done list.
|
||||
Returns True if the plugin was actually found.
|
||||
"""
|
||||
found = False
|
||||
for plugin in self.plugins:
|
||||
if plugin.__class__ == OrgNode:
|
||||
while old_state in plugin.todo_list:
|
||||
found = True
|
||||
plugin.todo_list.remove(old_state)
|
||||
while old_state in plugin.done_list:
|
||||
found = True
|
||||
plugin.done_list.remove(old_state)
|
||||
return found
|
||||
def extract_todo_list(self, todo_list=None):
|
||||
"""
|
||||
Extract a list of headings with TODO states specified by the first argument.
|
||||
"""
|
||||
if todo_list == None: # Set default
|
||||
# Kludge to get around lack of self in function declarations
|
||||
todo_list = self.get_todo_states()
|
||||
else:
|
||||
# Check to make sure all todo_list items are registered
|
||||
# with the OrgNode plugin
|
||||
for possible_state in todo_list:
|
||||
if possible_state not in self.get_todo_states("all"):
|
||||
raise ValueError("State " + possible_state + " not registered. See PyOrgMode.OrgDataStructure.add_todo_state.")
|
||||
results_list = []
|
||||
# Recursive function that steps through each node in current level,
|
||||
# looking for TODO items and then calls itself to look for
|
||||
# TODO items one level down.
|
||||
def extract_from_level(content):
|
||||
for node in content:
|
||||
# Check if it's a TODO item and add to results
|
||||
try:
|
||||
current_todo = node.todo
|
||||
except AttributeError:
|
||||
pass
|
||||
else: # Handle it
|
||||
if current_todo in todo_list:
|
||||
new_todo = OrgTodo(node.heading, node.todo)
|
||||
results_list.append(new_todo)
|
||||
# Now check if it has sub-headings
|
||||
try:
|
||||
next_content = node.content
|
||||
except AttributeError:
|
||||
pass
|
||||
else: # Hanble it
|
||||
extract_from_level(next_content)
|
||||
extract_from_level(self.root.content)
|
||||
return results_list
|
||||
def load_from_file(self,name,form="file"):
|
||||
"""
|
||||
Used to load an org-file inside this DataStructure
|
||||
"""
|
||||
current = self.root
|
||||
# Determine content type and put in appropriate form
|
||||
if form == "file":
|
||||
content = open(name,'r')
|
||||
elif form == "string":
|
||||
content = name.split("\n")
|
||||
else:
|
||||
raise ValueError("Form \""+form+"\" not recognized")
|
||||
|
||||
for line in content:
|
||||
for plugin in self.plugins:
|
||||
current = plugin.treat(current,line)
|
||||
if plugin.treated: # Plugin found something
|
||||
treated = True
|
||||
break;
|
||||
else:
|
||||
treated = False
|
||||
if not treated and line is not None: # Nothing special, just content
|
||||
current.append(line)
|
||||
|
||||
for plugin in self.plugins:
|
||||
current = plugin.close(current)
|
||||
|
||||
def load_from_string(self, string):
|
||||
"""
|
||||
A wrapper calling load_from_file but with a string instead of reading from a file.
|
||||
"""
|
||||
self.load_from_file(string, "string")
|
||||
|
||||
def save_to_file(self,name,node=None):
|
||||
"""
|
||||
Used to save an org-file corresponding to this DataStructure
|
||||
"""
|
||||
output = open(name,'w')
|
||||
if node == None:
|
||||
node = self.root
|
||||
output.write(str(node))
|
||||
output.close()
|
||||
@ -0,0 +1,122 @@
|
||||
#+BABEL: :comments no
|
||||
#+VERSION: 0.03a
|
||||
|
||||
**PyOrgMode is currently unmaintained, I do not use it anymore. It would benefit from a complete rewrite. There was no need for that stupid plugin architecture. Contact me if you are interested in getting it better, but I would really just recommend that it is just started from scratch with better practices of documentation, testing...**
|
||||
|
||||
* PyOrgMode
|
||||
PyOrgMode is a small python library able to do simple tasks with your org files. It allows you to generate org files or treat them in an automated fashion.
|
||||
|
||||
This project is not my top priority, but I'm more than happy to receive pull requests. Don't worry, even if it takes some time, I go through all of them ;)
|
||||
|
||||
I'd like to thank all the people that contributes (see AUTHORS file).
|
||||
|
||||
** Quick Start
|
||||
|
||||
*** Installation
|
||||
|
||||
Download the git repo and then install the package.
|
||||
#+BEGIN_SRC sh
|
||||
git clone https://github.com/bjonnh/PyOrgMode.git
|
||||
cd PyOrgMode/
|
||||
sudo python setup.py install
|
||||
#+END_SRC
|
||||
|
||||
*** Import an Org-Mode file
|
||||
|
||||
Import PyOrgMode
|
||||
|
||||
#+BEGIN_SRC python
|
||||
import PyOrgMode
|
||||
#+END_SRC
|
||||
|
||||
Create an Org data structure to hold the org-mode file.
|
||||
|
||||
#+BEGIN_SRC python
|
||||
base = PyOrgMode.OrgDataStructure()
|
||||
#+END_SRC
|
||||
|
||||
Load the org-mode file.
|
||||
|
||||
#+BEGIN_SRC python
|
||||
base.load_from_file("test.org")
|
||||
#+END_SRC
|
||||
|
||||
*** Create an org-mode file
|
||||
Create an Org data structure to hold the org-mode file.
|
||||
#+BEGIN_SRC python
|
||||
base = PyOrgMode.OrgDataStructure()
|
||||
#+END_SRC
|
||||
|
||||
Create a new TODO item
|
||||
#+BEGIN_SRC python
|
||||
new_todo = PyOrgMode.OrgNode.Element()
|
||||
new_todo.heading = "I am a new todo item"
|
||||
new_todo.tags=["things", "important"]
|
||||
new_todo.level = 1
|
||||
new_todo.todo = "TODO"
|
||||
#+END_SRC
|
||||
|
||||
Add a scheduled item and a deadline to the item.
|
||||
#+BEGIN_SRC python
|
||||
_sched = PyOrgMode.OrgSchedule()
|
||||
_sched._append(new_todo, _sched.Element(scheduled="<2015-08-01 Sat 12:00-13:00>"))
|
||||
_sched._append(new_todo, _sched.Element(deadline="<2015-08-01 Sat 12:00-13:00>"))
|
||||
#+END_SRC
|
||||
|
||||
Create a logbook drawer
|
||||
#+BEGIN_SRC python
|
||||
_props = PyOrgMode.OrgDrawer.Element("LOGBOOK")
|
||||
# Add a properties drawer
|
||||
_props.append(PyOrgMode.OrgDrawer.Element("- State \"SOMEDAY\" from \"TODO\" [2015-07-01 Wed 09:45]"))
|
||||
# Append the properties to the new todo item
|
||||
new_todo.append_clean(_props)
|
||||
#+END_SRC
|
||||
|
||||
Create a properties drawer
|
||||
#+BEGIN_SRC python
|
||||
_props = PyOrgMode.OrgDrawer.Element("PROPERTIES")
|
||||
# Add a properties drawer
|
||||
_props.append(PyOrgMode.OrgDrawer.Property("FRUITS", "pineapples"))
|
||||
_props.append(PyOrgMode.OrgDrawer.Property("NAMES", "bob, sally"))
|
||||
# Append the properties to the new todo item
|
||||
new_todo.append_clean(_props)
|
||||
#+END_SRC
|
||||
|
||||
Append the todo item to the base object
|
||||
#+BEGIN_SRC python
|
||||
base.root.append_clean(new_todo)
|
||||
#+END_SRC
|
||||
|
||||
Save the org object to a file
|
||||
#+BEGIN_SRC python
|
||||
base.save_to_file("output.org")
|
||||
#+END_SRC
|
||||
|
||||
** Tools
|
||||
[[elisp:org-babel-tangle][Tangle]] (Export the files)
|
||||
** Documentation
|
||||
*** Authors
|
||||
:PROPERTIES:
|
||||
:ID: 5b9ea3e5-f67b-4be7-9c55-6f1923b04e79
|
||||
:END:
|
||||
#+srcname: authors
|
||||
#+begin_src ascii :tangle AUTHORS :exports code
|
||||
Jonathan BISSON <firstname.lastname at bjonnh.net> : initiator of the project
|
||||
Antti KAIHOLA <akaihol plus orgmode at ambitone dot com>
|
||||
m3wolf (github)
|
||||
bordercore (github)
|
||||
wroberts (github)
|
||||
gonvaled (github)
|
||||
10nin (github)
|
||||
CodeMonk (github)
|
||||
midraal (github)
|
||||
whacked (github)
|
||||
maxandersen (github)
|
||||
CodeMonk (github)
|
||||
midraal (github)
|
||||
Seamus Tuohy (@elationfoundation on github)
|
||||
clemente (github)
|
||||
kbarber2 (github)
|
||||
sp1ff (github)
|
||||
inducer (github)
|
||||
#+end_src
|
||||
@ -0,0 +1,13 @@
|
||||
from distutils.core import setup
|
||||
|
||||
setup(
|
||||
name = 'PyOrgMode',
|
||||
packages = ['PyOrgMode'], # this must be the same as the name above
|
||||
version = '0.1',
|
||||
description = 'Library to interact with org-mode from python',
|
||||
author = 'Jonathan BISSON',
|
||||
author_email = 'Jonathan.BISSON@bjonnh.net',
|
||||
url = 'https://github.com/bjonnh/PyOrgMode', # use the URL to the github repo
|
||||
keywords = ['org-mode'],
|
||||
classifiers = [],
|
||||
)
|
||||
Loading…
Reference in new issue