Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Integration layer making it possible to load schema definitions from XML

Project description

Introduction

plone.supermodel provides XML import and export for schema interfaces based on zope.schema fields. The principal use cases are:

1. Define a schema interface in code based on an XML file. This can be done with syntax like:

>>> from plone.supermodel import xmlSchema
>>> IMySchema = xmlSchema("myschema.xml")

2. Save and load interface definitions via an XML format. To turn a schema interface into XML, you can do:

>>> from plone.supermodel import serializeSchema
>>> xml_string = serializeSchema(IMySchema)

To get a schema from an XML file, you can use the xmlSchema() function above, or you can use the more powerful spec() function, which turns a dict of all schemata and widget hints in a given XML file.

See schema.txt and interfaces.py in the source code for more information, including details on how to give widget hints for forms and how to keep multiple schemata in the same XML file.

Supermodel vs. Userschema

This package is quite similar to Tres Seaver’s “userschema” library, which can be found at http://agendaless.com/Members/tseaver/software/userschema.

In fact, plone.supermodel was originally based on userschema. However, as the package was refined and refactored, less and less of userschema remained, to the point where we’d have needed to significantly refactor the latter to keep using it.

The XML import/export code is currently based on algorithms that were written for plone.app.portlets and plone.app.contentrules’ GenericSetup handlers.

Some of the key differences between the two packages are:

  • userschema can create schema interfaces from HTML forms and CSV spreadsheets. plone.supermodel does not support such configuration.

  • Schemata created with userschema are typically loaded at startup, with a ZCML directive. plone.supermodel supports a “pseudo-base class” syntax, as seen above, to define interfaces in Python code. Beyond that, its API is more geared towards runtime configuration.

  • plone.supermodel supports serialisation of schemata to XML.

  • The plone.supermodel XML syntax is more directly tied to zope.schema fields, and infers most parameters from the schema interface declared by each zope.schema field. This has two advantages:

    • API documentation for zope.schema can be easily applied to <schema /> blocks
    • New fields and obscure attributes are easier to support
  • plone.supermodel’s XML schema is intended to support more schema metadata, including widget hints.

In the future, it may be possible to make userschema re-use part of plone.supermodel or vice-a-versa, with more refactoring.

Changelog

1.0b2 - 2009-07-12

  • Changed API methods and arguments to mixedCase to be more consistent with the rest of Zope. This is a non-backwards-compatible change. Our profuse apologies, but it’s now or never. :-/

    If you find that you get import errors or unknown keyword arguments in your code, please change names from foo_bar too fooBar, e.g. load_file() becomes loadFile(). [optilude]

  • No longer include name kwarg to Field constructor if no name was set [MatthewWilkes]

1.0b1 - 2009-04-17

  • Initial release

Project details


Release history Release notifications

History Node

1.3.4

History Node

1.3.3

History Node

1.3.2

History Node

1.3.1

History Node

1.3.0

History Node

1.2.7

History Node

1.2.6

History Node

1.2.5

History Node

1.2.4

History Node

1.2.3

History Node

1.2.2

History Node

1.2.1

History Node

1.2.0

History Node

1.1.4

History Node

1.1.3

History Node

1.1.2

History Node

1.1.1

History Node

1.1

History Node

1.0.4

History Node

1.0.3

History Node

1.0.2

History Node

1.0.1

History Node

1.0

History Node

1.0b8

History Node

1.0b7

History Node

1.0b6

History Node

1.0b5

History Node

1.0b4

History Node

1.0b3

This version
History Node

1.0b2

History Node

1.0b1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
plone.supermodel-1.0b2.tar.gz (30.4 kB) Copy SHA256 hash SHA256 Source None Jul 12, 2009

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page