[Python-modules-commits] [pygtail] 01/04: Import pygtail_0.6.1.orig.tar.gz

Christopher Baines cbaines-guest at moszumanska.debian.org
Tue May 10 07:41:51 UTC 2016


This is an automated email from the git hooks/post-receive script.

cbaines-guest pushed a commit to branch master
in repository pygtail.

commit 8eaae72a268da06300c910f1f872af9826755aff
Author: Christopher Baines <mail at cbaines.net>
Date:   Tue May 10 08:24:59 2016 +0100

    Import pygtail_0.6.1.orig.tar.gz
---
 .gitignore                   |   6 +
 .travis.yml                  |  12 ++
 LICENSE                      | 339 +++++++++++++++++++++++++++++++++++++++++++
 README.md                    |  47 ++++++
 README.txt                   |  49 +++++++
 makedoc.sh                   |   3 +
 pygtail/__init__.py          |   2 +
 pygtail/core.py              | 299 ++++++++++++++++++++++++++++++++++++++
 pygtail/test/__init__.py     |   1 +
 pygtail/test/test_pygtail.py | 210 +++++++++++++++++++++++++++
 pypi.txt                     |   6 +
 setup.py                     |  44 ++++++
 tox.ini                      |  13 ++
 13 files changed, 1031 insertions(+)

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..9310832
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,6 @@
+*.pyc
+*.egg-info
+.coverage
+build
+dist
+.tox
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..2ddbf33
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,12 @@
+language: python
+python:
+  - 2.6
+  - 2.7
+  - pypy
+#  - 3.1  # no longer supported on travis
+  - 3.2
+  - 3.3
+script: python setup.py test
+
+install:
+  - if [[ $TRAVIS_PYTHON_VERSION == 2.6 ]]; then pip install --use-mirrors unittest2; fi
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..ecbc059
--- /dev/null
+++ b/LICENSE
@@ -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.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1baf970
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+pygtail
+=======
+
+A python "port" of [logcheck's logtail2](http://logcheck.org).
+
+Pygtail reads log file lines that have not been read. It will even handle log
+files that have been rotated.
+
+Usage
+-----
+
+From the command line:
+
+    Usage: pygtail.py [options] logfile
+
+    Print log file lines that have not been read.
+
+    Options:
+      -h, --help            show this help message and exit
+      -o OFFSET_FILE, --offset-file=OFFSET_FILE
+                            File to which offset data is written (default:
+                            <logfile>.offset).
+      -p, --paranoid        Update the offset file every time we read a line
+                            (as opposed to only when we reach the end of the
+                            file).
+      -n N, --every-n=N     Update the offset file every N'th time we read a
+                            line (as opposed to only when we reach the end of
+                            the file).
+      --no-copytruncate     Don't support copytruncate-style log rotation.
+                            Instead, if the log file shrinks, print a warning.
+
+In your code:
+
+```python
+from pygtail import Pygtail
+
+for line in Pygtail("some.log"):
+    sys.stdout.write(line)
+```
+
+
+Build status
+------------
+
+[![Build Status](https://secure.travis-ci.org/bgreenlee/pygtail.png)](http://travis-ci.org/bgreenlee/pygtail)
+
+
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..e57185a
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,49 @@
+pygtail
+=======
+
+A python "port" of `logcheck's logtail2 <http://logcheck.org>`__.
+
+Pygtail reads log file lines that have not been read. It will even
+handle log files that have been rotated.
+
+Usage
+-----
+
+From the command line:
+
+::
+
+    Usage: pygtail.py [options] logfile
+
+    Print log file lines that have not been read.
+
+    Options:
+      -h, --help            show this help message and exit
+      -o OFFSET_FILE, --offset-file=OFFSET_FILE
+                            File to which offset data is written (default:
+                            <logfile>.offset).
+      -p, --paranoid        Update the offset file every time we read a line
+                            (as opposed to only when we reach the end of the
+                            file).
+      -n N, --every-n=N     Update the offset file every N'th time we read a
+                            line (as opposed to only when we reach the end of
+                            the file).
+      --no-copytruncate     Don't support copytruncate-style log rotation.
+                            Instead, if the log file shrinks, print a warning.
+
+In your code:
+
+.. code:: python
+
+    from pygtail import Pygtail
+
+    for line in Pygtail("some.log"):
+        sys.stdout.write(line)
+
+Build status
+------------
+
+|Build Status|
+
+.. |Build Status| image:: https://secure.travis-ci.org/bgreenlee/pygtail.png
+   :target: http://travis-ci.org/bgreenlee/pygtail
diff --git a/makedoc.sh b/makedoc.sh
new file mode 100755
index 0000000..3907e9b
--- /dev/null
+++ b/makedoc.sh
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+pandoc -f markdown -t rst -o README.txt README.md
diff --git a/pygtail/__init__.py b/pygtail/__init__.py
new file mode 100644
index 0000000..c81aed5
--- /dev/null
+++ b/pygtail/__init__.py
@@ -0,0 +1,2 @@
+from pygtail.core import __version__
+from pygtail.core import Pygtail
diff --git a/pygtail/core.py b/pygtail/core.py
new file mode 100755
index 0000000..4e6c780
--- /dev/null
+++ b/pygtail/core.py
@@ -0,0 +1,299 @@
+#!/usr/bin/python -tt
+# -*- coding: utf-8 -*-
+
+# pygtail - a python "port" of logtail2
+# Copyright (C) 2011 Brad Greenlee <brad at footle.org>
+#
+# Derived from logcheck <http://logcheck.org>
+# Copyright (C) 2003 Jonathan Middleton <jjm at ixtab.org.uk>
+# Copyright (C) 2001 Paul Slootman <paul at debian.org>
+#
+# 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+from __future__ import print_function
+from os import stat
+from os.path import exists, getsize
+import sys
+import glob
+import gzip
+from optparse import OptionParser
+
+__version__ = '0.6.1'
+
+
+PY3 = sys.version_info[0] == 3
+
+if PY3:
+    text_type = str
+else:
+    text_type = unicode
+
+
+def force_text(s, encoding='utf-8', errors='strict'):
+    if isinstance(s, text_type):
+        return s
+    return s.decode(encoding, errors)
+
+
+class Pygtail(object):
+    """
+    Creates an iterable object that returns only unread lines.
+
+    Keyword arguments:
+    offset_file   File to which offset data is written (default: <logfile>.offset).
+    paranoid      Update the offset file every time we read a line (as opposed to
+                  only when we reach the end of the file (default: False))
+    every_n       Update the offset file every n'th line (as opposed to only when
+                  we reach the end of the file (default: 0))
+    on_update     Execute this function when offset data is written (default False)
+    copytruncate  Support copytruncate-style log rotation (default: True)
+    """
+    def __init__(self, filename, offset_file=None, paranoid=False, copytruncate=True,
+                 every_n=0, on_update=False):
+        self.filename = filename
+        self.paranoid = paranoid
+        self.every_n = every_n
+        self.on_update = on_update
+        self.copytruncate = copytruncate
+        self._offset_file = offset_file or "%s.offset" % self.filename
+        self._offset_file_inode = 0
+        self._offset = 0
+        self._since_update = 0
+        self._fh = None
+        self._rotated_logfile = None
+
+        # if offset file exists and non-empty, open and parse it
+        if exists(self._offset_file) and getsize(self._offset_file):
+            offset_fh = open(self._offset_file, "r")
+            (self._offset_file_inode, self._offset) = \
+                [int(line.strip()) for line in offset_fh]
+            offset_fh.close()
+            if self._offset_file_inode != stat(self.filename).st_ino or \
+                    stat(self.filename).st_size < self._offset:
+                # The inode has changed or filesize has reduced so the file
+                # might have been rotated.
+                # Look for the rotated file and process that if we find it.
+                self._rotated_logfile = self._determine_rotated_logfile()
+
+    def __del__(self):
+        if self._filehandle():
+            self._filehandle().close()
+
+    def __iter__(self):
+        return self
+
+    def next(self):
+        """
+        Return the next line in the file, updating the offset.
+        """
+        try:
+            line = self._get_next_line()
+        except StopIteration:
+            # we've reached the end of the file; if we're processing the
+            # rotated log file, we can continue with the actual file; otherwise
+            # update the offset file
+            if self._rotated_logfile:
+                self._rotated_logfile = None
+                self._fh.close()
+                self._offset = 0
+                # open up current logfile and continue
+                try:
+                    line = self._get_next_line()
+                except StopIteration:  # oops, empty file
+                    self._update_offset_file()
+                    raise
+            else:
+                self._update_offset_file()
+                raise
+
+        if self.paranoid:
+            self._update_offset_file()
+        elif self.every_n and self.every_n <= self._since_update:
+            self._update_offset_file()
+
+        return line
+
+    def __next__(self):
+        """`__next__` is the Python 3 version of `next`"""
+        return self.next()
+
+    def readlines(self):
+        """
+        Read in all unread lines and return them as a list.
+        """
+        return [line for line in self]
+
+    def read(self):
+        """
+        Read in all unread lines and return them as a single string.
+        """
+        lines = self.readlines()
+        if lines:
+            try:
+                return ''.join(lines)
+            except TypeError:
+                return ''.join(force_text(line) for line in lines)
+        else:
+            return None
+
+    def _is_closed(self):
+        if not self._fh:
+            return True
+        try:
+            return self._fh.closed
+        except AttributeError:
+            if isinstance(self._fh, gzip.GzipFile):
+                # python 2.6
+                return self._fh.fileobj is None
+            else:
+                raise
+
+    def _filehandle(self):
+        """
+        Return a filehandle to the file being tailed, with the position set
+        to the current offset.
+        """
+        if not self._fh or self._is_closed():
+            filename = self._rotated_logfile or self.filename
+            if filename.endswith('.gz'):
+                self._fh = gzip.open(filename, 'r')
+            else:
+                self._fh = open(filename, "r", 1)
+            self._fh.seek(self._offset)
+
+        return self._fh
+
+    def _update_offset_file(self):
+        """
+        Update the offset file with the current inode and offset.
+        """
+        if self.on_update:
+            self.on_update()
+        offset = self._filehandle().tell()
+        inode = stat(self.filename).st_ino
+        fh = open(self._offset_file, "w")
+        fh.write("%s\n%s\n" % (inode, offset))
+        fh.close()
+        self._since_update = 0
+
+    def _determine_rotated_logfile(self):
+        """
+        We suspect the logfile has been rotated, so try to guess what the
+        rotated filename is, and return it.
+        """
+        rotated_filename = self._check_rotated_filename_candidates()
+        if rotated_filename and exists(rotated_filename):
+            if stat(rotated_filename).st_ino == self._offset_file_inode:
+                return rotated_filename
+
+            # if the inode hasn't changed, then the file shrank; this is expected with copytruncate,
+            # otherwise print a warning
+            if stat(self.filename).st_ino == self._offset_file_inode:
+                if self.copytruncate:
+                    return rotated_filename
+                else:
+                    sys.stderr.write(
+                        "[pygtail] [WARN] file size of %s shrank, and copytruncate support is "
+                        "disabled (expected at least %d bytes, was %d bytes).\n" %
+                        (self.filename, self._offset, stat(self.filename).st_size))
+
+        return None
+
+    def _check_rotated_filename_candidates(self):
+        """
+        Check for various rotated logfile filename patterns and return the first
+        match we find.
+        """
+        # savelog(8)
+        candidate = "%s.0" % self.filename
+        if (exists(candidate) and exists("%s.1.gz" % self.filename) and
+            (stat(candidate).st_mtime > stat("%s.1.gz" % self.filename).st_mtime)):
+            return candidate
+
+        # logrotate(8)
+        # with delaycompress
+        candidate = "%s.1" % self.filename
+        if exists(candidate):
+            return candidate
+
+        # without delaycompress
+        candidate = "%s.1.gz" % self.filename
+        if exists(candidate):
+            return candidate
+
+        # dateext rotation scheme
+        candidates = glob.glob("%s-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]" % self.filename)
+        if candidates:
+            candidates.sort()
+            return candidates[-1]  # return most recent
+
+        # for TimedRotatingFileHandler
+        candidates = glob.glob("%s.[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]" % self.filename)
+        if candidates:
+            candidates.sort()
+            return candidates[-1]  # return most recent
+
+        # no match
+        return None
+
+    def _get_next_line(self):
+        line = self._filehandle().readline()
+        if not line:
+            raise StopIteration
+        self._since_update += 1
+        return line
+
+
+def main():
+    # command-line parsing
+    cmdline = OptionParser(usage="usage: %prog [options] logfile",
+        description="Print log file lines that have not been read.")
+    cmdline.add_option("--offset-file", "-o", action="store",
+        help="File to which offset data is written (default: <logfile>.offset).")
+    cmdline.add_option("--paranoid", "-p", action="store_true",
+        help="Update the offset file every time we read a line (as opposed to"
+             " only when we reach the end of the file).")
+    cmdline.add_option("--every-n", "-n", action="store",
+        help="Update the offset file every n'th time we read a line (as opposed to"
+             " only when we reach the end of the file).")
+    cmdline.add_option("--no-copytruncate", action="store_true",
+        help="Don't support copytruncate-style log rotation. Instead, if the log file"
+             " shrinks, print a warning.")
+    cmdline.add_option("--version", action="store_true",
+        help="Print version and exit.")
+
+    options, args = cmdline.parse_args()
+
+    if options.version:
+        print("pygtail version", __version__)
+        sys.exit(0)
+
+    if (len(args) != 1):
+        cmdline.error("Please provide a logfile to read.")
+
+    if options.every_n:
+        options.every_n = int(options.every_n)
+    pygtail = Pygtail(args[0],
+                      offset_file=options.offset_file,
+                      paranoid=options.paranoid,
+                      every_n=options.every_n,
+                      copytruncate=not options.no_copytruncate)
+
+    for line in pygtail:
+        sys.stdout.write(line)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/pygtail/test/__init__.py b/pygtail/test/__init__.py
new file mode 100644
index 0000000..4287ca8
--- /dev/null
+++ b/pygtail/test/__init__.py
@@ -0,0 +1 @@
+#
\ No newline at end of file
diff --git a/pygtail/test/test_pygtail.py b/pygtail/test/test_pygtail.py
new file mode 100644
index 0000000..0648e8b
--- /dev/null
+++ b/pygtail/test/test_pygtail.py
@@ -0,0 +1,210 @@
+import os
+import sys
+try:
+    # python 2.6
+    import unittest2 as unittest
+except ImportError:
+    import unittest
+import shutil
+import tempfile
+import gzip
+import io
+from pygtail import Pygtail
+
+PY2 = sys.version_info[0] == 2
+
+
+class PygtailTest(unittest.TestCase):
+    # TODO:
+    # - test for non-default offset file
+    # - test for savelog and datext rotation schemes
+
+    def setUp(self):
+        self.test_lines = ["1\n", "2\n", "3\n"]
+        self.test_str = ''.join(self.test_lines)
+        self.logfile = tempfile.NamedTemporaryFile(delete=False)
+        self.logfile.write(self.test_str.encode('utf-8'))
+        self.logfile.close()
+
+    def append(self, str):
+        # append the give string to the temp logfile
+        fh = open(self.logfile.name, "a")
+        fh.write(str)
+        fh.close()
+
+    def copytruncate(self):
+        shutil.copyfile(self.logfile.name, "%s.1" % self.logfile.name)
+        fh = open(self.logfile.name, "w")
+        fh.close()
+
+    def tearDown(self):
+        filename = self.logfile.name
+        for tmpfile in [filename, filename + ".offset", filename + ".1", filename + ".1.gz"]:
+            if os.path.exists(tmpfile):
+                os.remove(tmpfile)
+
+    def test_read(self):
+        pygtail = Pygtail(self.logfile.name)
+        self.assertEqual(pygtail.read(), self.test_str)
+
+    def test_readlines(self):
+        pygtail = Pygtail(self.logfile.name)
+        self.assertEqual(pygtail.readlines(), self.test_lines)
+
+    def test_subsequent_read_with_no_new_data(self):
+        pygtail = Pygtail(self.logfile.name)
+        self.assertEqual(pygtail.read(), self.test_str)
+        self.assertEqual(pygtail.read(), None)
+
+    def test_subsequent_read_with_new_data(self):
+        pygtail = Pygtail(self.logfile.name)
+        self.assertEqual(pygtail.read(), self.test_str)
+        new_lines = "4\n5\n"
+        self.append(new_lines)
+        new_pygtail = Pygtail(self.logfile.name)
+        self.assertEqual(new_pygtail.read(), new_lines)
+
+    def test_logrotate_without_delay_compress(self):
+        new_lines = ["4\n5\n", "6\n7\n"]
+        pygtail = Pygtail(self.logfile.name)
+        pygtail.read()
+        self.append(new_lines[0])
+
+        # put content to gzip file
+        gzip_handle = gzip.open("%s.1.gz" % self.logfile.name, 'wb')
+        with open(self.logfile.name, 'rb') as logfile:
+            gzip_handle.write(logfile.read())
+        gzip_handle.close()
+
+        with open(self.logfile.name, 'w'):
+            # truncate file
+            pass
+
+        self.append(new_lines[1])
+        pygtail = Pygtail(self.logfile.name)
+        self.assertEqual(pygtail.read(), ''.join(new_lines))
+
+    def test_logrotate_with_delay_compress(self):
+        new_lines = ["4\n5\n", "6\n7\n"]
+        pygtail = Pygtail(self.logfile.name)
+        pygtail.read()
+        self.append(new_lines[0])
+        os.rename(self.logfile.name, "%s.1" % self.logfile.name)
+        self.append(new_lines[1])
+        pygtail = Pygtail(self.logfile.name)
+        self.assertEqual(pygtail.read(), ''.join(new_lines))
+
+    def test_copytruncate_off_smaller(self):
+        self.test_readlines()
+        self.copytruncate()
+        new_lines = "4\n5\n"
+        self.append(new_lines)
+
+        sys.stderr = captured = io.BytesIO() if PY2 else io.StringIO()
+        pygtail = Pygtail(self.logfile.name, copytruncate=False)
+        captured_value = captured.getvalue()
+        sys.stderr = sys.__stderr__
+
+        assert_class = self.assertRegex if sys.version_info >= (3, 1) else self.assertRegexpMatches
+        assert_class(captured_value, r".*?\bWARN\b.*?\bshrank\b.*")
+        self.assertEqual(pygtail.read(), None)
+
+    def test_copytruncate_on_smaller(self):
+        self.test_readlines()
+        self.copytruncate()
+        new_lines = "4\n5\n"
+        self.append(new_lines)
+        pygtail = Pygtail(self.logfile.name, copytruncate=True)
+        self.assertEqual(pygtail.read(), new_lines)
+
+    def _test_copytruncate_larger(self, onoff):
+        self.test_readlines()
+        self.copytruncate()
+        self.append(self.test_str)
+        new_lines = "4\n5\n"
+        self.append(new_lines)
+        pygtail = Pygtail(self.logfile.name, copytruncate=onoff)
+        self.assertEqual(pygtail.read(), new_lines)
+
+    def test_copytruncate_larger_off(self):
+        self._test_copytruncate_larger(False)
+
+    def test_copytruncate_larger_on(self):
+        self._test_copytruncate_larger(True)
+
+    def test_offset_file(self):
+        pygtail = Pygtail(self.logfile.name, paranoid=True)
+
+        log_inode = os.stat(self.logfile.name).st_ino
+
+        next(pygtail)
+        with open(self.logfile.name + '.offset', 'r') as f:
+            inode, offset = int(next(f)), int(next(f))
+        self.assertEqual(inode, log_inode)
+        self.assertEqual(offset, 2)
+
+        next(pygtail)
+        with open(self.logfile.name + '.offset', 'r') as f:
+            inode, offset = int(next(f)), int(next(f))
+        self.assertEqual(inode, log_inode)
+        self.assertEqual(offset, 4)
+
+        next(pygtail)
+        with open(self.logfile.name + '.offset', 'r') as f:
+            inode, offset = int(next(f)), int(next(f))
+        self.assertEqual(inode, log_inode)
+        self.assertEqual(offset, 6)
+
+    def test_on_update_with_paranoid(self):
+        updates = [0]
... 133 lines suppressed ...

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/pygtail.git



More information about the Python-modules-commits mailing list