[Python-modules-commits] [python-bugzilla] 01/04: Import python-bugzilla-1.2.2.orig.tar.gz
Sergio Durigan Junior
sergiodj-guest at moszumanska.debian.org
Fri Jun 24 21:34:16 UTC 2016
This is an automated email from the git hooks/post-receive script.
sergiodj-guest pushed a commit to branch master
in repository python-bugzilla.
commit 532e7c836d60237a3c9d16864afef4e4c79cdd10
Author: Sergio Durigan Junior <sergiodj at sergiodj.net>
Date: Thu Jun 23 20:17:00 2016 -0400
Import python-bugzilla-1.2.2.orig.tar.gz
---
CONTRIBUTING.md | 77 ++
COPYING | 339 +++++
MANIFEST.in | 6 +
PKG-INFO | 10 +
README.md | 14 +
bin/bugzilla | 1336 ++++++++++++++++++
bugzilla.1 | 385 ++++++
bugzilla/__init__.py | 133 ++
bugzilla/apiversion.py | 11 +
bugzilla/base.py | 1821 +++++++++++++++++++++++++
bugzilla/bug.py | 541 ++++++++
bugzilla/bugzilla3.py | 34 +
bugzilla/bugzilla4.py | 47 +
bugzilla/rhbugzilla.py | 551 ++++++++
bz-api-notes.txt | 123 ++
python-bugzilla.spec | 95 ++
python_bugzilla.egg-info/PKG-INFO | 10 +
python_bugzilla.egg-info/SOURCES.txt | 39 +
python_bugzilla.egg-info/dependency_links.txt | 1 +
python_bugzilla.egg-info/pbr.json | 1 +
python_bugzilla.egg-info/requires.txt | 1 +
python_bugzilla.egg-info/top_level.txt | 1 +
requirements.txt | 1 +
setup.cfg | 5 +
setup.py | 203 +++
test-requirements.txt | 3 +
tests/__init__.py | 111 ++
tests/bug.py | 84 ++
tests/createbug.py | 92 ++
tests/data/bz-attach-get1.txt | 33 +
tests/data/components_file.txt | 3 +
tests/data/cookies-bad.txt | 1 +
tests/data/cookies-lwp.txt | 3 +
tests/data/cookies-moz.txt | 6 +
tests/misc.py | 172 +++
tests/modify.py | 209 +++
tests/pep8.cfg | 10 +
tests/pylint.cfg | 254 ++++
tests/query.py | 316 +++++
tests/ro_functional.py | 258 ++++
tests/rw_functional.py | 885 ++++++++++++
41 files changed, 8225 insertions(+)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..df1ab0b
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,77 @@
+# Setting up the environment
+
+If you already have system installed versions of python-bugzilla
+dependencies, running the command line from git is as simple as doing:
+
+ cd python-bugzilla.git
+ ./bugzilla-cli [arguments]
+
+If you want to use pip and virtualenv to install a local development
+environment, use the following command.
+
+ source contrib/activate-dev-env [python2|python3]
+
+Then you can manually activate an environment with:
+
+ source dev-env-${NAME}/bin/activate
+
+
+# Running tests
+
+Once you have already activated an environment, you can use the following.
+
+## Basic unit test suite
+
+ python setup.py test
+
+## Read-Only Functional tests
+There are more comprehensive tests that are disabled by default. Readonly
+functional tests that run against several public bugzilla instances. No
+login account is required:
+
+ python setup.py test --ro-functional
+
+## Read/Write Functional Tests.
+
+Before running rw-functional tests, make sure you have logged into bugzilla
+using. These currently run against the test bugzilla instance at
+partner-bugzilla.redhat.com, and requires a valid login there:
+
+ bugzilla-cli --bugzilla=partner-bugzilla.redhat.com --user=$USER login
+ python setup.py test --rw-functional
+
+## Testing across python versions
+To test all supported python versions, run tox using any of the following.
+
+ tox
+ tox -- --ro-functional
+ tox -- --rw-functional
+
+
+# pylint and pep8
+
+To test for pylint or pep8 violations, you can run:
+
+ python setup.py pylint
+
+Note: This expects that you already have pylint and pep8 (installed when setting
+up virtualenv) installed.
+
+
+# Patch Submission
+
+If you are submitting a patch, ensure the following:
+ [REQ] verify that no new pylint or pep8 violations
+ [REQ] run basic unit test suite across all python versions as described
+ above.
+
+Running any of the functional tests is not a requirement for patch submission,
+but please give them a go if you are interested.
+
+Patches can be submitted via github pull-request, or via the mailing list
+at python-bugzilla at lists.fedorahosted.org using 'git send-email'.
+
+
+# Bug reports
+
+Bug reports should be submitted as github issues, or sent to the mailing list
diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..d159169
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,339 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) 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
+this service 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 make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. 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.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+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
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the 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 a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE 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.
+
+ 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
+convey 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 2 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, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision 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, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This 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.
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..db856ad
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,6 @@
+include COPYING CONTRIBUTING.md MANIFEST.in README.md
+include bugzilla.1
+include bz-api-notes.txt
+include python-bugzilla.spec
+include *requirements.txt
+recursive-include tests *.py *.txt *.cfg
diff --git a/PKG-INFO b/PKG-INFO
new file mode 100644
index 0000000..946cdea
--- /dev/null
+++ b/PKG-INFO
@@ -0,0 +1,10 @@
+Metadata-Version: 1.0
+Name: python-bugzilla
+Version: 1.2.2
+Summary: Bugzilla XMLRPC access module
+Home-page: https://github.com/python-bugzilla/python-bugzilla
+Author: Cole Robinson
+Author-email: python-bugzilla at lists.fedorahosted.org
+License: GPLv2
+Description: UNKNOWN
+Platform: UNKNOWN
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..df0186f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# python-bugzilla
+
+This package provides two bits:
+
+* 'bugzilla' python module for talking to a [Bugzilla](https://www.bugzilla.org/) instance over XMLRPC
+* /usr/bin/bugzilla command line tool for performing actions from the command line: create or edit bugs, various queries, etc.
+
+This was originally written specifically for Red Hat's Bugzilla instance
+and is used heavily at Red Hat and in Fedora, but it should still be
+generically useful.
+
+For questions about submitting bug reports or patches, see [CONTRIBUTING.md](CONTRIBUTING.md)
+
+Questions, comments, and discussions should go to our mailing: http://lists.fedorahosted.org/mailman/listinfo/python-bugzilla
diff --git a/bin/bugzilla b/bin/bugzilla
new file mode 100755
index 0000000..8397df9
--- /dev/null
+++ b/bin/bugzilla
@@ -0,0 +1,1336 @@
+#!/usr/bin/python -tt
+#
+# bugzilla - a commandline frontend for the python bugzilla module
+#
+# Copyright (C) 2007, 2008, 2009, 2010, 2011 Red Hat Inc.
+# Author: Will Woods <wwoods at redhat.com>
+#
+# 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 2 of the License, or (at your
+# option) any later version. See http://www.gnu.org/copyleft/gpl.html for
+# the full text of the license.
+
+from __future__ import print_function
+
+import locale
+from logging import DEBUG, INFO, WARN, StreamHandler, Formatter
+import optparse
+import os
+import re
+import socket
+import sys
+import tempfile
+
+if hasattr(sys.version_info, "major") and sys.version_info.major >= 3:
+ # pylint: disable=F0401,W0622
+ from xmlrpc.client import Fault, ProtocolError
+ basestring = (str, bytes)
+else:
+ from xmlrpclib import Fault, ProtocolError
+
+import requests.exceptions
+
+import bugzilla
+
+default_bz = 'https://bugzilla.redhat.com/xmlrpc.cgi'
+
+_is_unittest = bool(os.getenv("__BUGZILLA_UNITTEST"))
+cmdlist = ['login', 'new', 'query', 'modify', 'attach', 'info']
+format_field_re = re.compile("%{([a-z0-9_]+)(?::([^}]*))?}")
+
+log = bugzilla.log
+handler = StreamHandler(sys.stderr)
+handler.setFormatter(Formatter(
+ "[%(asctime)s] %(levelname)s (%(module)s:%(lineno)d) %(message)s",
+ "%H:%M:%S"))
+log.addHandler(handler)
+
+
+################
+# Util helpers #
+################
+
+def to_encoding(ustring):
+ string = ''
+ if isinstance(ustring, basestring):
+ string = ustring
+ elif ustring is not None:
+ string = str(ustring)
+
+ if hasattr(sys.version_info, "major") and sys.version_info.major >= 3:
+ return string
+ else:
+ preferred = locale.getpreferredencoding()
+ if "PYTHON_BUGZILLA_TEST_SUITE" in os.environ:
+ preferred = "UTF-8"
+ return string.encode(preferred, 'replace')
+
+
+def open_without_clobber(name, *args):
+ '''Try to open the given file with the given mode; if that filename exists,
+ try "name.1", "name.2", etc. until we find an unused filename.'''
+ fd = None
+ count = 1
+ orig_name = name
+ while fd is None:
+ try:
+ fd = os.open(name, os.O_CREAT | os.O_EXCL, 0o666)
+ except OSError:
+ err = sys.exc_info()[1]
+ if err.errno == os.errno.EEXIST:
+ name = "%s.%i" % (orig_name, count)
+ count += 1
+ else:
+ raise IOError(err.errno, err.strerror, err.filename)
+ fobj = open(name, *args)
+ if fd != fobj.fileno():
+ os.close(fd)
+ return fobj
+
+
+##################
+# Option parsing #
+##################
+
+def setup_parser():
+ u = ("%%prog [global options] COMMAND [command-options]"
+ "\n\nCommands: %s" % ', '.join(sorted(cmdlist)))
+ p = optparse.OptionParser(usage=u, version=bugzilla.__version__)
+ p.disable_interspersed_args()
+ p.epilog = 'Try "bugzilla COMMAND --help" for command-specific help.'
+
+ # General bugzilla connection options
+ p.add_option('--bugzilla', default=default_bz,
+ help="bugzilla XMLRPC URI. default: %s" % default_bz)
+ p.add_option("--nosslverify", dest="sslverify",
+ action="store_false", default=True,
+ help="Don't error on invalid bugzilla SSL certificate")
+
+ p.add_option('--user', help="Optional bugzilla login username")
+ p.add_option('--password', help="Optional bugzilla login password")
+ p.add_option('--login', action="store_true",
+ help='Run interactive "login" before performing the '
+ 'specified command.')
+ p.add_option('--ensure-logged-in', action="store_true",
+ help="Raise an error if we aren't logged in to bugzilla. "
+ "Consider using this if you are depending on "
+ "cached credentials, to ensure that when they expire the "
+ "tool errors, rather than subtly change output.")
+ p.add_option('--no-cache-credentials',
+ action='store_false', default=True, dest='cache_credentials',
+ help="Don't save any bugzilla cookies or tokens to disk, and "
+ "don't use any pre-existing credentials.")
+
+ p.add_option('--cookiefile', default=None,
+ help="cookie file to use for bugzilla authentication")
+ p.add_option('--tokenfile', default=None,
+ help="token file to use for bugzilla authentication")
+
+ p.add_option('--verbose', action='store_true',
+ help="give more info about what's going on")
+ p.add_option('--debug', action='store_true',
+ help="output bunches of debugging info")
+
+ # Generate the man page, dump to stdout. Not for end users
+ p.add_option('--generate-man', action='store_true',
+ help=optparse.SUPPRESS_HELP)
+
+ # Allow user to specify BZClass to initialize. Kinda weird for the
+ # CLI, I'd rather people file bugs about this so we can fix our detection.
+ # So hide it from the help output but keep it for back compat
+ p.add_option('--bztype', default='auto', help=optparse.SUPPRESS_HELP)
+
+ return p
+
+
+def setup_action_parser(action):
+ p = optparse.OptionParser(usage="%%prog %s [options]" % action)
+
+ if action == 'new':
+ p.set_description("Create a new bug report.")
+ p.add_option('-p', '--product', help="REQUIRED: product name")
+ p.add_option('-v', '--version', help="REQUIRED: product version")
+ p.add_option('-c', '--component', help="REQUIRED: component name")
+ p.add_option("--sub-component", help="Optional sub component name")
+ p.add_option('-s', '--short_desc', '--summary', dest='summary',
+ help="REQUIRED: bug summary")
+ p.add_option('-l', '--comment', dest='description',
+ help="initial bug comment")
+ p.add_option('-o', '--os', help="Operating system")
+ p.add_option('-a', '--arch', help="Arch this bug occurs on")
+ p.add_option('--severity', help="Bug severity")
+ p.add_option('--priority', help="Bug priority")
+ p.add_option('-u', '--url', help="URL for further bug info")
+ p.add_option('--cc',
+ metavar='CC[, CC, ...]', action="append",
+ help="add emails to initial CC list")
+ p.add_option('--blocked',
+ metavar='BUGID[, BUGID, ...]', action="append",
+ help="add bug_ids blocked by this bug")
+ p.add_option('--dependson',
+ metavar='BUGID[, BUGID, ...]', action="append",
+ help="add bug_ids that this bug depends on")
+ p.add_option('--groups',
+ metavar='GROUP[, GROUP, ...]', action="append",
+ help="add groups to which bug is visible")
+ p.add_option('--assigned_to',
+ help='Assign bugzilla to specified email address')
+ p.add_option('--qa_contact',
+ help='Set QA contact to specified email address')
+ p.add_option('--keywords',
+ metavar='KEYWORD[, KEYWORD, ...]', action="append",
+ help="Set specified keywords on new bugzilla")
+ p.add_option('--alias',
+ help='An alias (name) for the bug (must be unique)')
+
+ elif action == 'query':
+ p.set_description("List bug reports that match the given criteria.")
+ # General bug metadata
+ p.add_option('-b', '--bug_id', default=None,
+ help="specify individual bugs by IDs, separated with commas")
+ p.add_option('-p', '--product',
+ help="product name, comma-separated "
+ "(list with 'bugzilla info --products')")
+ p.add_option('-v', '--version',
+ help="product version, comma-separated")
+ p.add_option('-c', '--component',
+ help="component name(s), comma-separated "
+ "(list with 'bugzilla info --components PRODUCT')")
+ p.add_option("--sub-component", action="append",
+ help="Sub component. Can be specified multiple times")
+ p.add_option('--components_file', default=None,
+ help="list of component names from a file, one component "
+ "per line (list with 'bugzilla info -c PRODUCT')")
+ p.add_option('-l', '--long_desc',
+ help="search inside bug comments")
+ p.add_option('-m', '--target_milestone',
+ help="search for a target milestone")
+ p.add_option('-s', '--short_desc',
+ help="search bug summaries")
+ p.add_option('-t', '--bug_status', default="ALL",
+ help="comma-separated list of bug statuses to accept "
+ "[Default:all]")
+ p.add_option('-x', '--bug_severity', '--severity',
+ help="search severities, comma-separated")
+ p.add_option('-z', '--priority',
+ help="search priorities, comma-separated")
+
+ # Email
+ malg = optparse.OptionGroup(p, "Email Options")
+ malg.add_option('-E', '--emailtype', default="substring",
+ help="Email: specify searching option for emails, "
+ "ie. substring, notsubstring, exact, ... "
+ "[Default: substring]")
+ malg.add_option('-o', '--cc',
+ help="Email: search cc lists for given address")
+ malg.add_option('-r', '--reporter',
+ help="Email: search reporter email for given address")
+ malg.add_option('-a', '--assigned_to',
+ help="Email: search for bugs assigned to this address")
+ malg.add_option('-q', '--qa_contact',
+ help="Email: search for bugs which have QA Contact "
+ "assigned to this address")
+ p.add_option_group(malg)
+
+ # Strings
+ stro = optparse.OptionGroup(p, "String search options")
+ stro.add_option('-u', '--url',
+ help="search keywords field for given url")
+ stro.add_option('-U', '--url_type',
+ help="specify searching option for urls, "
+ "ie. anywords, allwords, nowords")
+ stro.add_option('-k', '--keywords',
+ help="search keywords field for specified words")
+ stro.add_option('-K', '--keywords_type',
+ help="specify searching option for keywords, "
+ "ie. anywords, allwords, nowords")
+ stro.add_option('-w', '--status_whiteboard',
+ help="search Status Whiteboard field for specified words")
+ stro.add_option('-W', '--status_whiteboard_type',
+ help="specify searching option for Status Whiteboard, "
+ "ie. anywords, allwords, nowords")
+ stro.add_option("--tags", help="Search bug 'tags' field")
+ p.add_option_group(stro)
+
+ # Precomposed queries
+ p.add_option('--from-url',
+ help="Use the query given by a query.cgi URL. (Use quotes!)")
+ p.add_option('--quicksearch',
+ help="Search using bugzilla's quicksearch functionality.")
+ p.add_option('--savedsearch',
+ help="Name of a bugzilla saved search. If you don't own this "
+ "saved search, you must passed --savedsearch_sharer_id.")
+ p.add_option('--savedsearch-sharer-id',
+ help="Owner ID of the --savedsearch. You can get this ID from "
+ "the URL bugzilla generates when running the saved search "
+ "from the web UI.")
+
+ # Boolean Charts
+ bgrp = optparse.OptionGroup(p, "Boolean options")
+ bgrp.add_option('-B', '--booleantype', default="substring",
+ help="specify searching option for booleans, ie. substring, "
+ "notsubstring, exact, ... [Default: substring]")
+ bgrp.add_option('--boolean_query', action="append",
+ help="Create your own query. Format: "
+ "BooleanName-Condition-Parameter &/| ... . ie, "
+ "keywords-substring-Partner & "
+ "keywords-notsubstring-OtherQA")
+ bgrp.add_option('--blocked', action="append",
+ help="Search for bugs that block this bug ID")
+ bgrp.add_option('--dependson', action="append",
+ help="Search for bugs that depend on this bug ID")
+ bgrp.add_option('--flag', action='append',
+ help="Search for bugs that have certain "
+ "flag states present. Ex --flags=dev_ack+")
+ bgrp.add_option('--qa_whiteboard', action="append",
+ help="search for bugs that have certain QA "
+ "Whiteboard text present")
+ bgrp.add_option('--devel_whiteboard', action="append",
+ help="search for bugs that have certain "
+ "Devel Whiteboard text present")
+ bgrp.add_option('--alias', action="append",
+ help="search for bugs that have the provided alias")
+ bgrp.add_option('--fixed_in', action="append",
+ help="search Status Whiteboard field for specified words")
+ p.add_option_group(bgrp)
+
+ elif action == 'info':
+ p.set_description("Get information about the bugzilla server.")
+ p.add_option('-p', '--products', action='store_true',
+ help='Get a list of products')
+ p.add_option('-c', '--components', metavar="PRODUCT",
+ help='List the components in the given product')
+ p.add_option('-o', '--component_owners', metavar="PRODUCT",
+ help='List components (and their owners)')
+ p.add_option('-v', '--versions', metavar="VERSION",
+ help='List the versions for the given product')
+
+ elif action == 'modify':
+ p.set_usage("%prog modify [options] BUGID [BUGID...]")
+ p.set_description("Modify one or more bugs.")
+
+ bgrp = optparse.OptionGroup(p, "Bug details")
+ bgrp.add_option('--product',
+ help="Reassign bug to different product")
+ bgrp.add_option('-c', '--component',
+ help="Reassign bug to different component")
+ bgrp.add_option("--sub-component",
+ help="Reassign bug to different sub-component (rhbz extension)")
+ bgrp.add_option("-v", '--version',
+ help="Reassign bug to different version")
+ bgrp.add_option('-o', '--os',
+ help="Change operating system this bug occurs on")
+ bgrp.add_option('-a', '--arch',
+ help="Change arch this bug occurs on")
+ bgrp.add_option('-u', '--url',
+ help="URL for further bug info")
+ bgrp.add_option('--alias',
+ help='An alias (name) for the bug (must be unique)')
+ p.add_option_group(bgrp)
+
+ sgrp = optparse.OptionGroup(p, "Bug status options")
+ sgrp.add_option('-s', '--status',
+ help='Change status of bug')
+ sgrp.add_option('-k', '--close', metavar="RESOLUTION",
+ help='Close with the given resolution')
+ sgrp.add_option('-d', '--dupeid', metavar="ORIGINAL",
+ help='ID of original bug (implies -k DUPLICATE)')
+ sgrp.add_option('-F', '--fixed_in', metavar="VERSION",
+ help='"Fixed in version" field')
+ p.add_option_group(sgrp)
+
+ cgrp = optparse.OptionGroup(p, "Comment options")
+ cgrp.add_option('-l', '--comment',
+ help='Add a comment')
+ cgrp.add_option('-p', '--private', action='store_true', default=False,
+ help='Mark new comment as private')
+ cgrp.add_option("--summary", help="Change bug summary")
+ p.add_option_group(cgrp)
+
+ egrp = optparse.OptionGroup(p, "Contact options")
+ egrp.add_option('--assignee',
+ help='Assign bugzilla to assignee')
+ egrp.add_option('--cc', action='append', metavar="EMAIL",
+ help='Alter CC list. EMAIL appends, -EMAIL removes.')
+ egrp.add_option('--qa_contact',
+ help='Change QA contact')
+ egrp.add_option('--reset-assignee', action="store_true",
+ help='Reset assignee to component default')
+ egrp.add_option('--reset-qa-contact', action="store_true",
+ help='Reset QA contact to component default')
+ egrp.add_option('--groups', metavar='GROUP[, GROUP, ...]',
+ action="append",
+ help="add groups to which bug is visible")
+ p.add_option_group(egrp)
+
+ tgrp = optparse.OptionGroup(p, "Tracking options")
+ tgrp.add_option('-f', '--flag', action='append',
+ help='Update bugzilla flags with requested type, '
+ 'ie fedora-cvs?, or needinfoX to clear '
+ '(Use a new option for each flag)')
+ tgrp.add_option('--severity', help="Change bug severity")
+ tgrp.add_option('--priority', help="Change bug priority")
+ tgrp.add_option('--target_milestone', help="Set target milestone")
+ tgrp.add_option('--target_release', help="Set target release")
+ tgrp.add_option('--blocked',
+ metavar='BUGID[, BUGID, ...]', action="append",
+ help="Add bug_ids blocked by this bug. BUGID appends, "
+ "-BUGID removes, =BUGID overwrites")
+ tgrp.add_option('--dependson', metavar='BUGID[, BUGID, ...]',
+ action="append",
+ help=('Alter depends_on list. BUGID appends, '
+ '-BUGID removes, =BUGID overwrites'))
+ tgrp.add_option('--keywords',
+ metavar='KEYWORD', action="append",
+ help="Alter bug keywords list. KEYWORD appends, "
+ "-KEYWORD removes, =KEYWORD overwrites")
+ tgrp.add_option("", "--whiteboard", metavar="TEXT", action="append",
+ help='Alter status whiteboard text. '
+ 'TEXT appends, -TEXT removes, =TEXT overwrites')
+ tgrp.add_option("--devel_whiteboard",
+ metavar="TEXT", action="append",
+ help='Alter devel whiteboard text. '
+ 'TEXT appends, -TEXT removes, =TEXT overwrites')
+ tgrp.add_option("--internal_whiteboard",
+ metavar="TEXT", action="append",
+ help='Alter internal whiteboard text. '
+ 'TEXT appends, -TEXT removes, =TEXT overwrites')
+ tgrp.add_option("--qa_whiteboard",
+ metavar="TEXT", action="append",
+ help='Alter QA whiteboard. '
+ 'TEXT appends, -TEXT removes, =TEXT overwrites')
+ tgrp.add_option("--tags", metavar="TEXT", action="append",
+ help="Alter bug 'tags' field"
+ "TEXT appends, -TEXT removes")
+ p.add_option_group(tgrp)
+
+
+ elif action == 'attach':
+ p.set_usage('''
+ %prog attach --file=FILE --desc=DESC [--type=TYPE] BUGID [BUGID...]
+ %prog attach --get=ATTACHID --getall=BUGID [...]
+ %prog attach --type=TYPE BUGID [BUGID...]''')
+ p.set_description("Attach files or download attachments.")
+ p.add_option('-f', '--file', metavar="FILENAME",
+ help='File to attach, or filename for data provided on stdin')
+ p.add_option('-d', '--description', metavar="DESCRIPTION", dest='desc',
+ help="A short description of the file being attached")
+ p.add_option('-t', '--type', metavar="MIMETYPE",
+ help="Mime-type for the file being attached")
+ p.add_option('-g', '--get', metavar="ATTACHID", action="append",
+ default=[], help="Download the attachment with the given ID")
+ p.add_option("--getall", "--get-all", metavar="BUGID", action="append",
+ default=[], help="Download all attachments on the given bug")
+
+ elif action == 'login':
+ p.set_usage('%prog login [username [password]]')
+ p.set_description(
+ "Log into bugzilla and save a login cookie or token.")
+
+ if action in ['new', 'query']:
+ outg = optparse.OptionGroup(p, "Output format options")
+ outg.add_option('-f', '--full', action='store_const', dest='output',
+ const='full', default='normal',
+ help="output detailed bug info")
+ outg.add_option('-i', '--ids', action='store_const', dest='output',
+ const='ids', help="output only bug IDs")
+ outg.add_option('-e', '--extra', action='store_const',
+ dest='output', const='extra',
+ help="output additional bug information "
+ "(keywords, Whiteboards, etc.)")
+ outg.add_option('--oneline', action='store_const', dest='output',
+ const='oneline',
+ help="one line summary of the bug (useful for scripts)")
+ outg.add_option('--raw', action='store_const', dest='output',
+ const='raw', help="raw output of the bugzilla contents")
+ outg.add_option('--outputformat',
+ help="Print output in the form given. "
+ "You can use RPM-style tags that match bug "
+ "fields, e.g.: '%{id}: %{summary}'. See the man page "
+ "section 'OUTPUT FORMAT' for more details.")
+ p.add_option_group(outg)
+
+ if action in ['new', 'query', 'modify']:
+ message = {
+ 'new': 'Set a specified field.',
+ 'query': 'Query a specified field.',
+ 'modify': 'Modify a specified field.'
+ }.get(action)
+ p.add_option('--field', help="%s FIELD is expected to be \
+ the raw name used by the bugzilla instance. No safety \
+ checks are perfomed when using this option." % (message),
+ action="append", type="str", dest="fields",
+ metavar="FIELD=VALUE")
+
+
+ # Used by unit tests, not for end user consumption
+ if action in ['new', 'query', 'modify']:
+ p.add_option('--test-return-result', action="store_true",
... 7522 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-bugzilla.git
More information about the Python-modules-commits
mailing list