Silme:Tutorial:Concepts

[This is a part of silme tutorial]

Silme is built around several abstract concepts that allow the library to support any possible localization format, from DTD, GetText or XLIFF, to MySQL and SQLite, from JAR and normal directory to SVN, CVS or any other Revision Control System. In this section I will explain the basic concepts that will allow you to understand the architecture of the library. Of course it is just an introduction, Silme allows you to extend each class with your data, but here we will focus on the simplest cases.

Objects

Entity

Silme's most core and atom unit is Entity. Entity is a class that stores single pair of ID<-->VALUE in an abstract model. It is a representation of DTD's

<!ENTITY ID "VALUE">

, Gettext's

msgid "ID"\nmsgstr "VALUE"

, MySQL's ID column and VALUE column in L10n table etc., etc...

It's very important to understand that you can serialize any localization list to use Entity as long as you can generate unique ID across one list and assign it a value.

EntityList

Group of Entity objects is stored as a EntityList object. EntityList is a list (in fact, a dict structure in Python) that stores list of Entities and nothing more. The easiest way to imagine it is a localization SQL table containing two columns - ID and VALUE. The single row is Entity, the whole table is EntityList.

L10nObject

Above that, in some abstract sense, there is L10nObject class. L10nObject extends EntityList and is a representation of any L10n file. So beside of list of Entity objects it also contains Comment objects and normal Strings between them. It's easiest to imagine it as a full representation of simple DTD file:

<!ENTITY myapp.title "MyApp Title">
<!--
Not used anymore
<!ENTITY title.old "Some Title">
-->
<!ENTITY notify.msg "Please, click OK to continue">
<!ENTITY notify.btn "OK">

will look like this:

String('\n')
Entity(id:'myapp.title',value:'MyApp Title')
String('\n')
Comment(
  String('\nNot used anymore\n')
  Entity(id:'title.old', value:'Some Title')
)
String('\n')
Entity(id:'notify.msg',value:'Please, click OK to continue')
String('\n')
Entity(id:'notify.btn',value:'OK')
String('\n\n')

L10nObject is more like a file, EntityList like a SQL table. You can get EntityList out of L10nObject or you can get EntityList out of a file directly if you don't want to use the other elements of the structure.

L10nObject stores whole content of the file and should always represent the full file, which means that dumping this structure back to the same format will produce identical file as a source one. In the middle you can operate, move, remove, add strings, comments and entities.

Blob

Beside of L10nObject we have similar structure called Blob. Blob is used to store data about files that we cannot parse. If, for example, your application will be prepared to parse DTD/PO/Properties and will get HTML file or JPEG it will store it as an Blob. Blob has an ID and source properties. Not very useful but will allow us to build a full structure above it:

L10nPackage

L10nPackage is a representation of list of L10nObjects/Blob/EntityLists and potentially other L10nPackages. In the file system world, the nearest similar thing is a directory. Directory can store DTD files, JPEG files, and other directories. Another similar structure is MySQL database which stores tables (EntityLists in our case).

Summary

That's all. Currently the scope of the library is to present all potential localization structures using those classes and build an API to operate on them easily.

Diff module

Each and every of the objects - Entity, EntityList, L10nObject, Blob, L10nPackage has it's mirror class in the Diff land. So in result we have EntityDiff, EntityListDiff, L10nObjectDiff, BlobDiff, L10nPackageDiff. Diff module allows you to store a difference between two objects of the same type and apply it later. It's like a diff tool in Linux, beside that it is aware of the syntax of the files/structures and stores the diff in appropriate way. For example if a diff between two EntityLists is a value of one entity, it'll store it as EntityDiff with ID of that entity and (oldvalue,newvalue) tuple.

In case of an API, it'll usually go down to:

l10npackagediff = l10npackage1.diff(l10npackage2)

l10npackage3.apply_diff(l10npackagediff)

l10npackage4.apply_diff(l10npackagediff)

but of course you will be able to manually operate on all structures by adding/removing/modifying the content of each object.

I/O

Because we want to support multiply methods of accessing entities lists, we need to abstract the layer of Input-Output. In Silme, IOManager is a class that manages all IO classes called IOClients. Example three IOClients:

io_client = silme.io.Manager.get('file')
l10nobject = io_client.get_l10nobject(path='./test/example.dtd')

io_client = silme.io.Manager.get('svn')
l10nobject = io_client.get_l10nobject(path='svn://svn.server.net/project/trunk/example.dtd')

io_client = silme.ioManager.get('mysql')
entitylist = io_client.get_entitylist(path='mysql://localhost:8908/l10ndb', table='l10nList')

Of course you can also use get_entitylist on file and SVN, but you cannot get L10nObject from MySQL.

You can also go the "raw" way by asking io_client to give you the source of the file, and then manually create L10nObject out of it. To parse the simple string into L10nObject or EntityList we use:

FormatParsers

FormatParser is a class that can parse string into L10nObject or L10nObject to string. Example FormatParsers are DTD/GetText/Properties/XLIFF/L20n. They're managed by silme.format.Manager:

io_client = silme.io.Manager.get('file')
fp = silme.format.Manager.get('dtd')
string = io_client.get_source(path='./test/example.dtd')
l10nobject = fp.get_l10nobject(string)

l10nobject.add_entity(silme.core.Entity('id','value'), pos=('after','test.id'))


# to save the file you can use this:
io_client.write_object(l10nobject, path='./test/example2.dtd')
# or:
string = fp.dump_l10nobject(l10nobject)
io_client.write_to_file(string, path='./test/example2.dtd')

Summary

That's all for now. This article explained the basic concepts behind the library and I hope you'll find the library useful enough to experiment with writing apps on top of it and/or working with the library itself.

Now, how to set up an environment.