Package cssutils
[hide private]
[frames] | no frames]

Package cssutils

source code

cssutils - CSS Cascading Style Sheets library for Python

Copyright (C) 2004-2008 Christof Hoeke

cssutils is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

A Python package to parse and build CSS Cascading Style Sheets. DOM only, not any rendering facilities!

Based upon and partly implementing the following specifications :

CSS 2.1
General CSS rules and properties are defined here
CSS 2.1 Errata
A few errata, mainly the definition of CHARSET_SYM tokens
CSS3 Module: Syntax
Used in parts since cssutils 0.9.4. cssutils tries to use the features from CSS 2.1 and CSS 3 with preference to CSS3 but as this is not final yet some parts are from CSS 2.1
MediaQueries
MediaQueries are part of stylesheets.MediaList since v0.9.4, used in @import and @media rules.
Namespaces
Added in v0.9.1, updated to definition in CSSOM in v0.9.4, updated in 0.9.5 for dev version
Selectors
The selector syntax defined here (and not in CSS 2.1) should be parsable with cssutils (should mind though ;) )
DOM Level 2 Style CSS
DOM for package css
DOM Level 2 Style Stylesheets
DOM for package stylesheets
CSSOM
A few details (mainly the NamespaceRule DOM) is taken from here. Plan is to move implementation to the stuff defined here which is newer but still no REC so might change anytime...

The cssutils tokenizer is a customized implementation of CSS3 Module: Syntax (W3C Working Draft 13 August 2003) which itself is based on the CSS 2.1 tokenizer. It tries to be as compliant as possible but uses some (helpful) parts of the CSS 2.1 tokenizer.

I guess cssutils is neither CSS 2.1 nor CSS 3 compliant but tries to at least be able to parse both grammars including some more real world cases (some CSS hacks are actually parsed and serialized). Both official grammars are not final nor bugfree but still feasible. cssutils aim is not to be fully compliant to any CSS specification (the specifications seem to be in a constant flow anyway) but cssutils should be able to read and write as many as possible CSS stylesheets "in the wild" while at the same time implement the official APIs which are well documented. Some minor extensions are provided as well.

Please visit http://cthedot.de/cssutils/ for more details.

Tested with Python 2.5 on Windows XP.

This library may be used from cssutils import * which import subpackages css and stylesheets, CSSParser and CSSSerializer classes only.

Usage may be:

>>> from cssutils import *
>>> parser = CSSParser()
>>> sheet = parser.parseString(u'a { color: red}')
>>> print sheet.cssText

Version: 0.9.5rc1 $Id: __init__.py 1333 2008-07-09 13:27:04Z cthedot $

Date: $LastChangedDate:: 2008-07-09 15:27:04 +0200 #$:

Author: Christof Hoeke with contributions by Walter Doerwald

Submodules [hide private]

Classes [hide private]
  CSSParser
parses a CSS StyleSheet string or file and returns a DOM Level 2 CSS StyleSheet object
  CSSSerializer
Methods to serialize a CSSStylesheet and its parts
  DOMImplementationCSS
This interface allows the DOM user to create a CSSStyleSheet outside the context of a document.
Functions [hide private]
 
getUrls(sheet)
Utility function to get all url(urlstring) values in CSSImportRules and CSSStyleDeclaration objects (properties) of given CSSStyleSheet sheet.
source code
 
parseFile(*a, **k)
Retrieve and return a CSSStyleSheet from given filename.
source code
 
parseString(*a, **k)
Return parsed CSSStyleSheet from given string cssText.
source code
 
parseUrl(*a, **k)
Retrieve and return a CSSStyleSheet from given href (an URL).
source code
 
replaceUrls(sheet, replacer)
Utility function to replace all url(urlstring) values in CSSImportRules and CSSStyleDeclaration objects (properties) of given CSSStyleSheet sheet.
source code
 
setSerializer(serializer)
sets the global serializer used by all class in cssutils
source code
Variables [hide private]
  _ANYNS = -1
  log = cssutils.log
  ser = CSSSerializer()

Imports: Deprecated, codec, cssproductions, errorhandler, helper, parse, serialize, tokenize2, util, xml


Function Details [hide private]

getUrls(sheet)

source code 

Utility function to get all url(urlstring) values in CSSImportRules and CSSStyleDeclaration objects (properties) of given CSSStyleSheet sheet.

This function is a generator. The url values exclude url( and ) and surrounding single or double quotes.

parseFile(*a, **k)

source code 

Retrieve and return a CSSStyleSheet from given filename. Raises errors during retrieving (e.g. IOError).

filename
of the CSS file to parse, if no href is given filename is converted to a (file:) URL and set as href of resulting stylesheet. If href is given it is set as sheet.href. Either way sheet.href is used to resolve e.g. stylesheet imports via @import rules.
encoding
Value None defaults to encoding detection via BOM or an @charset rule. Other values override detected encoding for the sheet at filename including any imported sheets.

for other parameters see parseString

parseString(*a, **k)

source code 

Return parsed CSSStyleSheet from given string cssText. Raises errors during retrieving (e.g. UnicodeDecodeError).

cssText
CSS string to parse
encoding
If None the encoding will be read from BOM or an @charset rule or defaults to UTF-8. If given overrides any found encoding including the ones for imported sheets. It also will be used to decode cssText if given as a (byte) string.
href
The href attribute to assign to the parsed style sheet. Used to resolve other urls in the parsed sheet like @import hrefs
media
The media attribute to assign to the parsed style sheet (may be a MediaList, list or a string)
title
The title attribute to assign to the parsed style sheet

parseUrl(*a, **k)

source code 

Retrieve and return a CSSStyleSheet from given href (an URL). In case of any errors while reading the URL returns None.

href
URL of the CSS file to parse, will also be set as href of resulting stylesheet
encoding
Value None defaults to encoding detection via HTTP, BOM or an @charset rule. A value overrides detected encoding for the sheet at href including any imported sheets.

for other parameters see parseString

replaceUrls(sheet, replacer)

source code 

Utility function to replace all url(urlstring) values in CSSImportRules and CSSStyleDeclaration objects (properties) of given CSSStyleSheet sheet.

replacer must be a function which is called with a single argument urlstring which is the current value of url() excluding url( and ) and surrounding single or double quotes.