Just like any software, weppy is changing over time, and most of these changes we introduce don't require you to change anything into your application code to profit from a new release.
Sometimes, indeed, there are changes in weppy source code that do require some changes or there are possibilities for you to improve your own code quality, taking advantage of new features in weppy.
This section of the documentation reports all the main changes in weppy from one release to the next and how you can (or you should) update your application's code to have the less painful upgrade experience.
Just as a remind, you can update weppy using easy_install:
$ easy_install -U weppy
or pip:
$ pip install -U weppy
weppy 0.5 introduces python 3 support. Fortunately, there are no changes in the main code that require changes in your application code.
Note:
Internally, weppy dropped an old library for utf8 utilities, needed for the translator. Since this part of weppy had been rewritten for python 3 support, the usage of that library (Utf8
class) is no longer required. If you used it in your own code, please make the appropriate changes in order to drop it.
weppy 0.4 introduces a lot of major changes that break backward compatibility on the DAL
, Auth
, validation and forms modules among all the prior versions. These changes are a consequence of the introduction of a real ORM inside weppy (while prior versions just had a layer of abstraction over the database).
Please also keep in mind that weppy 0.4 dropped support of python 2.6.x. Please upgrade your python interpreter to 2.7.
Next paragraphs describe the relevant changes for your application in order to upgrade the code from weppy 0.3.
The Field
class previously required a name
as first parameter. In weppy 0.4 the name is injected by weppy depending on the name of the variable you use for store the field instance.
As an immediate consequence, fields are now Model
attributes, instead of elements of the fields
attribute which is no more available. Your model should be upgraded from the old notation:
class Thing(Model):
fields = [
Field('name'),
Field('value', 'integer')
]
to the new (and more convenient):
class Thing(Model):
name = Field()
value = Field('integer')
You should also update all your Form
instances, since you should pass a dict
of fields instead of a list
as first parameter, so from:
form = Form([Field('name'), Field('value', 'integer')])
to:
form = Form({'name': Field(), 'value': Field('int')})
We changed the nomenclature of the Model
class attributes to a proper one. Here is the complete list of old names vs the new ones:
old name | new name |
---|---|
validators | validation |
defaults | default_values |
updates | update_values |
representation | repr_values |
visibility | form_rw |
labels | form_labels |
comments | form_info |
widgets | form_widgets |
Please, update your models to the new structure.
Also, note that the previously available attribute Model.entity
is now the more appropriate Model.table
.
weppy 0.4 introduces a totally refactored validation mechanism, and a new syntax for validation. In particular, the suggested syntax now uses dictionaries instead of lists of validator classes for validation.
Since this change removed quite a lot of previously available validators, we suggest you to convert your validation to the new system, which is documented in the appropriate chapter.
If you still want to use the old notation, here is the list of changes in validators classes:
validator | change |
---|---|
isIntInRange | removed |
isFloatInRange | removed |
isDecimalInRange | removed |
isDateInRange | removed |
isDatetimeInRange | removed |
isEmailList | removed |
isListOf | renamed into isList |
isStrong | deprecated (available under weppy.validators._old ) |
inDb | deprecated (available under weppy.validators._old ) |
notInDb | deprecated (available under weppy.validators._old ) |
FilenameMatches | deprecated (available under weppy.validators._old ) |
anyOf | renamed to Any |
Slug | renamed to Urlify |
also, we added new validators that replace the removed ones:
validator | in place of |
---|---|
inRange | all the old range validators |
inDB | inDb |
notInDB | notInDb |
Since weppy 0.4 introduces a new naming convention for models and tables, the old authorization tables were rewritten.
The first consequence is that new Auth
tables have changed names:
old name | new name |
---|---|
auth_user | auth_users |
auth_group | auth_groups |
auth_membership | auth_memberships |
auth_permission | auth_permissions |
auth_event | auth_events |
Moreover, we also changed the name of the columns involved in relations, in particular:
auth_memberships
have changed user_id
and group_id
to user
and authgroup
auth_permissions
have changed group_id
to authgroup
auth_events
have changed user_id
to user
We suggest you to manually do these changes executing the proper sql commands with your database.
If you're not sure on what to do, we also provide a migration script, which tries to migrate the data. Please, do a full backup of your database before running the script. You can use it as follows:
weppy --app yourappname shell
(with your application name) and in the console:>>> from yourappname import app, db
>>> from weppy_04_upgrade import before_upgrade
>>> before_upgrade(app, db)
done
weppy --app yourname shell
(with your application name) and in the console:>>> from yourappname import app, db, auth
>>> from weppy_04_upgrade import after_upgrade
>>> after_upgrade(app, db, auth)
done
Then your auth tables should be good. The script created a 03dump.json into your application folder that you can safely delete among with the script itself.
weppy 0.4 also introduces some new features you may want to take advantage of:
Field
class now support pythonic naming for old integer and boolean types: you can now write int and boolModel
class now auto-generate the name for the table, if not specified (read more in the DAL chapter)belongs_to
, has_one
and has_many
apis are now available for relations in your models (read more in the DAL chapter)Field
and Model
(read more in the DAL chapter)abort
helper now also accept a body
parameter which allows you to customize the body of the returned HTTP errorweppy 0.3 introduces a caching system for the templates. This change add a new configuration value under app.config.templates_auto_reload
which is default set to False
.
This means that, under default behavior, in production weppy won't re-process the template files when modified, unless you reload the wsgi process. If you want to have the old behavior, so that weppy re-process the template file when it's modified, simply set the templates_auto_reload
variable to True
.
Also remind that when your application is in debug mode – which means when it's loaded with the builtin wsgi server – the configuration setting is ignored and templates are auto reloaded by default.
weppy 0.2 introduces some major changes in the code that break backward compatibility among the 0.1 developer preview. These changes were made to simplify the coding flow for developers and to have more consistent APIs.
If you're upgrading your application from weppy 0.1, next paragraphs describe the relevant changes for your application.
The Storage
class previously available under weppy.storage
has moved to the more convenient sdict
one. sdict
behaves exactly the same as Storage
, you just need to update references you have in your application, and the imports. You can import sdict
directly from weppy writing:
from weppy import sdict
weppy 0.2 uses new pyDAL package instead of the old fork of the web2py's DAL. Due to this new implementation, we removed the old ModelsDAL
class and unified the two classes under the DAL
one. Moreover, the weppy.dal.modules
package will no longer exists, so you should rewrite all your imports since everything that was in that package can be imported directly from weppy.dal
:
from weppy.dal import DAL, Field, Model, after_insert
Also, the old ModelsDAL.define_datamodels()
method is now available as DAL.define_models()
, please update the relevant line in your application:
db.define_models([MyModel1, MyModel2])
Finally, the Model
class now has only one setup
method instead of the old list of set_
methods. Please use only this method to configure your tables.
Due to ModelsDAL
and DAL
merge, we did the same to ModelsAuth
. Now you should use Auth
with the usermodel
parameter, like this:
auth = Auth(app, db, usermodel=User)
We renamed all the validators available in weppy. We changed the nomenclature we were keeping from web2py to a simpler one (under our point of view at least). Here is the complete list of old names vs the new ones:
old name | new name |
---|---|
IS_ALPHANUMERIC | isAlphanumeric |
ISINTIN_RANGE | isIntInRange |
ISFLOATIN_RANGE | isFloatInRange |
ISDECIMALIN_RANGE | isDecimalInRange |
IS_TIME | isTime |
IS_DATE | isDate |
ISDATEIN_RANGE | isDateInRange |
IS_DATETIME | isDatetime |
ISDATETIMEIN_RANGE | isDatetimeInRange |
IS_EMAIL | isEmail |
ISLISTOF_EMAILS | isEmailList |
IS_URL | isUrl |
IS_JSON | isJSON |
IS_IMAGE | isImage |
IS_IPV4 | isIPv4 |
IS_IPV6 | isIPv6 |
IS_IPADDRESS | isIP |
ISLISTOF | isListOf |
IS_STRONG | isStrong |
ISEMPTYOR | isEmptyOr |
ISNOTEMPTY | isntEmpty |
ISINDB | inDb |
ISNOTIN_DB | notInDb |
ISINSET | inSet |
IS_LENGTH | hasLength |
ISEQUALTO | Equals |
IS_MATCH | Matches |
ISUPLOADFILENAME | FilenameMatches |
ANY_OF | anyOf |
CLEANUP | Cleanup |
CRYPT | Crypt |
IS_LOWER | Lower |
IS_UPPER | Upper |
IS_SLUG | Slug |
Please not that we also removed the IS_EXPR
validator. The reason for the removal is that we had to run an exec
on the expression, which is not a so good operation, and you can actually achieve the same result writing your own validator. As an example, if you were writing this before:
IS_EXPR('str(form.vars.a).endswith("asd")')
you can better define a custom validator:
from weppy.validators import Validator
class EndsWithAsd(Validator):
def __call__(self, value):
if str(value).endswith('asd'):
return (value, None)
return (value, "value has to end with 'asd'")
We renamed the old stream_file()
method under weppy.helpers
to the more convenient stream_dbfile()
, plase update the lines involved in your code.
The usage remains the same.
weppy 0.2 also introduces some new features you may want to take advantage of:
request.post_vars
. If you want to use this feature, ensure to send the content to weppy with the Content-Type header set to "application/json". SessionFSManager
is now available to store sessions on server's filesystem. For the complete usage please check the Session chapter of the documentation. stream_file()
method under weppy.helpers
allows you to stream a file stored into your application path, simply passing the location as the parameter: stream_file("myfiles/book.pdf")
. xml
is now available under services to allow rendering content as XML