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

> This library 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 2.1 of the License, or (at your option) any later version.

> This library 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 library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

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.5b2 $Id: __init__.py 1189 2008-03-21 22:33:10Z cthedot $

Date: $LastChangedDate:: 2008-03-21 23:33:10 +0100 #$:

Author: Christof Hoeke with contributions by Walter Doerwald

Submodules | [hide private]
cssutils.codec: Python codec for CSS. cssutils.css: Document Object Model Level 2 CSS http://www.w3.org/TR/2000/PR-DOM-Level-2-Style-20000927/css.html cssutils.css.csscharsetrule: CSSCharsetRule implements DOM Level 2 CSS CSSCharsetRule. cssutils.css.csscomment: CSSComment is not defined in DOM Level 2 at all but a cssutils defined class only. cssutils.css.cssfontfacerule: CSSFontFaceRule implements DOM Level 2 CSS CSSFontFaceRule. cssutils.css.cssimportrule: CSSImportRule implements DOM Level 2 CSS CSSImportRule. cssutils.css.cssmediarule: CSSMediaRule implements DOM Level 2 CSS CSSMediaRule. cssutils.css.cssnamespacerule: CSSNamespaceRule currently implements http://dev.w3.org/csswg/css3-namespace/ cssutils.css.csspagerule: CSSPageRule implements DOM Level 2 CSS CSSPageRule. cssutils.css.cssproperties: CSS2Properties (partly!) implements DOM Level 2 CSS CSS2Properties used by CSSStyleDeclaration cssutils.css.cssrule: CSSRule implements DOM Level 2 CSS CSSRule. cssutils.css.cssrulelist: CSSRuleList implements DOM Level 2 CSS CSSRuleList. cssutils.css.cssstyledeclaration: CSSStyleDeclaration implements DOM Level 2 CSS CSSStyleDeclaration and extends CSS2Properties cssutils.css.cssstylerule: CSSStyleRule implements DOM Level 2 CSS CSSStyleRule. cssutils.css.cssstylesheet: CSSStyleSheet implements DOM Level 2 CSS CSSStyleSheet. cssutils.css.cssunknownrule: CSSUnknownRule implements DOM Level 2 CSS CSSUnknownRule. cssutils.css.cssvalue: CSSValue related classes cssutils.css.property: Property is a single CSS property in a CSSStyleDeclaration cssutils.css.selector: Selector is a single Selector of a CSSStyleRule SelectorList. cssutils.css.selectorlist: SelectorList is a list of CSS Selector objects. cssutils.css2productions: productions for CSS 2.1 cssutils.css3productions: productions for CSS 3 cssutils.cssproductions: productions for cssutils based on a mix of CSS 2.1 and CSS 3 Syntax productions cssutils.errorhandler: cssutils ErrorHandler cssutils.parse': a validating CSSParser cssutils.scripts cssutils.scripts.csscapture: Retrieve all CSS stylesheets including embedded for a given URL. cssutils.scripts.csscombine cssutils.scripts.csscombine': combines sheets referred to by @import rules in a given CSS proxy sheet into a single new sheet. cssutils.scripts.cssparse: utility scripts installed as Python scripts cssutils.serialize: serializer classes for CSS classes cssutils.stylesheets: Document Object Model Level 2 Style Sheets http://www.w3.org/TR/2000/PR-DOM-Level-2-Style-20000927/stylesheets.html cssutils.stylesheets.medialist: MediaList implements DOM Level 2 Style Sheets MediaList. cssutils.stylesheets.mediaquery: MediaQuery, see http://www.w3.org/TR/css3-mediaqueries/ cssutils.stylesheets.stylesheet: StyleSheet implements DOM Level 2 Style Sheets StyleSheet. cssutils.stylesheets.stylesheetlist: StyleSheetList implements DOM Level 2 Style Sheets StyleSheetList. cssutils.tests: cssutils unittests cssutils.tests.basetest: Base class for all tests cssutils.tests.encutils: tests for encutils.py cssutils.tests.test_codec: Testcases for cssutils.codec cssutils.tests.test_csscharsetrule: Testcases for cssutils.css.CSSCharsetRule cssutils.tests.test_csscomment: Testcases for cssutils.css.CSSComment cssutils.tests.test_cssfontfacerule: Testcases for cssutils.css.CSSFontFaceRule cssutils.tests.test_cssimportrule: Testcases for cssutils.css.CSSImportRule cssutils.tests.test_cssmediarule: Testcases for cssutils.css.CSSMediaRule cssutils.tests.test_cssnamespacerule: Testcases for cssutils.css.CSSImportRule cssutils.tests.test_csspagerule: Testcases for cssutils.css.CSSPageRule cssutils.tests.test_cssproperties: Testcases for cssutils.css.cssproperties. cssutils.tests.test_cssrule: Testcases for cssutils.css.CSSRule cssutils.tests.test_cssrulelist: Testcases for cssutils.css.CSSRuleList cssutils.tests.test_cssstyledeclaration: Testcases for cssutils.css.cssstyledelaration.CSSStyleDeclaration. cssutils.tests.test_cssstylerule: Testcases for cssutils.css.CSSStyleRuleTestCase cssutils.tests.test_cssstylesheet: Tests for css.CSSStyleSheet cssutils.tests.test_cssunknownrule: testcases for cssutils.css.CSSUnkownRule cssutils.tests.test_cssutils: Testcases for cssutils.css.CSSCharsetRule cssutils.tests.test_cssutilsimport: Testcase for cssutils imports cssutils.tests.test_cssvalue: Testcases for cssutils.css.CSSValue and CSSPrimitiveValue. cssutils.tests.test_domimplementation: Testcases for cssutils.css.DOMImplementation cssutils.tests.test_medialist: Testcases for cssutils.stylesheets.MediaList cssutils.tests.test_mediaquery: Testcases for cssutils.stylesheets.MediaList cssutils.tests.test_parse: Tests for parsing which does not raise Exceptions normally cssutils.tests.test_property: Testcases for cssutils.css.property._Property. cssutils.tests.test_scripts_csscombine: Testcases for cssutils.scripts.csscombine cssutils.tests.test_selector: Testcases for cssutils.css.selector.Selector. cssutils.tests.test_selectorlist: Testcases for cssutils.css.selectorlist.SelectorList. cssutils.tests.test_serialize: Testcases for cssutils.CSSSerializer cssutils.tests.test_tokenize2: Testcases for new cssutils.tokenize.Tokenizer cssutils.tests.test_util: Testcases for cssutils.util cssutils.tokenize2: New CSS Tokenizer (a generator) cssutils.util: base classes for css and stylesheets packages

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
parse(*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 (a 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: codec, cssproductions, errorhandler, 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.

### parse(*a, **k) | source code
Retrieve and return a CSSStyleSheet from given filename. 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 of the CSS file, `None` defaults to encoding detection from BOM or an @charset rule. `encoding` is used for the sheet at `filename` (and may override a file internal encoding) but not any imported sheets where the file internal encoding is detected. for other parameters see `parseString`

### parseString(*a, **k) | source code
Return parsed CSSStyleSheet from given string cssText. cssText CSS string to parse encoding encoding of the CSS string. if `None` the encoding will be read from a @charset rule. If there is none, the parser will fall back to UTF-8. If cssText is a unicode string encoding will be ignored. 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 (a URL). href URL of the CSS file to parse, will also be set as `href` of resulting stylesheet encoding if given overrides detected HTTP or file internal encoding for sheet at `href` but not any imported sheets where the encoding if always detected via HTTP or from the file. 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.