← Back
Editing: text_file.pyo
� { fc @ s/ d Z d Z d d l Z d d d � � YZ d S( s� text_file provides the TextFile class, which gives an interface to text files that (optionally) takes care of stripping comments, ignoring blank lines, and joining lines with backslashes.s $Id$i����Nt TextFilec B s� e Z d Z i d d 6d d 6d d 6d d 6d d 6d d 6Z d d d � Z d � Z d � Z d d � Z d d � Z d d � Z d � Z d � Z d � Z RS( s� Provides a file-like object that takes care of all the things you commonly want to do when processing a text file that has some line-by-line syntax: strip comments (as long as "#" is your comment character), skip blank lines, join adjacent lines by escaping the newline (ie. backslash at end of line), strip leading and/or trailing whitespace. All of these are optional and independently controllable. Provides a 'warn()' method so you can generate warning messages that report physical line number, even if the logical line in question spans multiple physical lines. Also provides 'unreadline()' for implementing line-at-a-time lookahead. Constructor is called as: TextFile (filename=None, file=None, **options) It bombs (RuntimeError) if both 'filename' and 'file' are None; 'filename' should be a string, and 'file' a file object (or something that provides 'readline()' and 'close()' methods). It is recommended that you supply at least 'filename', so that TextFile can include it in warning messages. If 'file' is not supplied, TextFile creates its own using the 'open()' builtin. The options are all boolean, and affect the value returned by 'readline()': strip_comments [default: true] strip from "#" to end-of-line, as well as any whitespace leading up to the "#" -- unless it is escaped by a backslash lstrip_ws [default: false] strip leading whitespace from each line before returning it rstrip_ws [default: true] strip trailing whitespace (including line terminator!) from each line before returning it skip_blanks [default: true} skip lines that are empty *after* stripping comments and whitespace. (If both lstrip_ws and rstrip_ws are false, then some lines may consist of solely whitespace: these will *not* be skipped, even if 'skip_blanks' is true.) join_lines [default: false] if a backslash is the last non-newline character on a line after stripping comments and whitespace, join the following line to it to form one "logical line"; if N consecutive lines end with a backslash, then N+1 physical lines will be joined to form one logical line. collapse_join [default: false] strip leading whitespace from lines that are joined to their predecessor; only matters if (join_lines and not lstrip_ws) Note that since 'rstrip_ws' can strip the trailing newline, the semantics of 'readline()' must differ from those of the builtin file object's 'readline()' method! In particular, 'readline()' returns None for end-of-file: an empty string might just be a blank line (or an all-whitespace line), if 'rstrip_ws' is true but 'skip_blanks' is not.i t strip_commentst skip_blanksi t lstrip_wst rstrip_wst join_linest collapse_joinc K s� | d k r$ | d k r$ t d � n xQ | j j � D]@ } | | k r] t | | | | � q4 t | | | j | � q4 Wx3 | j � D]% } | | j k r� t d | � q� q� W| d k r� | j | � n | | _ | | _ d | _ g | _ d S( s� Construct a new TextFile object. At least one of 'filename' (a string) and 'file' (a file-like object) must be supplied. They keyword argument options are described above and affect the values returned by 'readline()'.s7 you must supply either or both of 'filename' and 'file's invalid TextFile option '%s'i N( t Nonet RuntimeErrort default_optionst keyst setattrt KeyErrort opent filenamet filet current_linet linebuf( t selfR R t optionst opt( ( s+ /usr/lib64/python2.7/distutils/text_file.pyt __init__N s c C s+ | | _ t | j d � | _ d | _ d S( sy Open a new file named 'filename'. This overrides both the 'filename' and 'file' arguments to the constructor.t ri N( R R R R ( R R ( ( s+ /usr/lib64/python2.7/distutils/text_file.pyR s s c C s2 | j } d | _ d | _ d | _ | j � d S( si Close the current file and forget everything we know about it (filename, current line number).N( R R R R t close( R R ( ( s+ /usr/lib64/python2.7/distutils/text_file.pyR | s c C s� g } | d k r | j } n | j | j d � t | t t f � ra | j d t | � � n | j d | � | j t | � � d j | � S( Ns , s lines %d-%d: s line %d: t ( R R t appendR t isinstancet listt tuplet strt join( R t msgt linet outmsg( ( s+ /usr/lib64/python2.7/distutils/text_file.pyt gen_error� s c C s t d | j | | � � d S( Ns error: ( t ValueErrorR" ( R R R ( ( s+ /usr/lib64/python2.7/distutils/text_file.pyt error� s c C s( t j j d | j | | � d � d S( s� Print (to stderr) a warning message tied to the current logical line in the current file. If the current logical line in the file spans multiple physical lines, the warning refers to the whole range, eg. "lines 3-5". If 'line' supplied, it overrides the current line number; it may be a list or tuple to indicate a range of physical lines, or an integer for a single physical line.s warning: s N( t syst stderrt writeR" ( R R R ( ( s+ /usr/lib64/python2.7/distutils/text_file.pyt warn� s c C s� | j r$ | j d } | j d =| Sd } x~| j j � } | d k rQ d } n | j r� | r� | j d � } | d k r~ q� | d k s� | | d d k r� | d d k r� d p� d } | d | !| } | j � d k r� q- q� q� | j d d � } n | j r�| r�| d k r'| j d � | S| j r?| j � } n | | } t | j t � rv| j d d | j d <q�| j | j d g | _ nI | d k r�d St | j t � r�| j d d | _ n | j d | _ | j r�| j r�| j � } n0 | j r| j � } n | j r,| j � } n | d k sD| d k rS| j rSq- n | j r�| d d k r|| d } q- n | d d k r�| d d !d } q- q�n | SWd S( sU Read and return a single logical line from the current file (or from an internal buffer if lines have previously been "unread" with 'unreadline()'). If the 'join_lines' option is true, this may involve reading multiple physical lines concatenated into a single string. Updates the current line number, so calling 'warn()' after 'readline()' emits a warning about the physical line(s) just read. Returns None on end-of-file, since the empty string can occur if 'rstrip_ws' is true but 'strip_blanks' is not.i����R t #i i s \s s \#s2 continuation line immediately precedes end-of-filei����s \ N( R R t readlineR R t findt stript replaceR R( R t lstripR R R R R t rstripR ( R R t buildup_linet post eol( ( s+ /usr/lib64/python2.7/distutils/text_file.pyR* � sf ! c C s: g } x- | j � } | d k r% | S| j | � q Wd S( sW Read and return the list of all logical lines remaining in the current file.N( R* R R ( R t linesR ( ( s+ /usr/lib64/python2.7/distutils/text_file.pyt readlines s c C s | j j | � d S( s� Push 'line' (a string) onto an internal buffer that will be checked by future 'readline()' calls. Handy for implementing a parser with line-at-a-time lookahead.N( R R ( R R ( ( s+ /usr/lib64/python2.7/distutils/text_file.pyt unreadline+ s N( t __name__t __module__t __doc__R R R R R R" R$ R( R* R4 R5 ( ( ( s+ /usr/lib64/python2.7/distutils/text_file.pyR s 8 % ~ ( ( R8 t __revision__R% R ( ( ( s+ /usr/lib64/python2.7/distutils/text_file.pyt <module> s
Save File
Cancel