File: migration.rst

package info (click to toggle)
py-serializable 2.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 524 kB
  • sloc: python: 2,271; xml: 519; makefile: 12
file content (58 lines) | stat: -rw-r--r-- 1,746 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
..  # This file is part of py-serializable
    #
    # Licensed under the Apache License, Version 2.0 (the "License");
    # you may not use this file except in compliance with the License.
    # You may obtain a copy of the License at
    #
    #     http://www.apache.org/licenses/LICENSE-2.0
    #
    # Unless required by applicable law or agreed to in writing, software
    # distributed under the License is distributed on an "AS IS" BASIS,
    # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    # See the License for the specific language governing permissions and
    # limitations under the License.
    #
    # SPDX-License-Identifier: Apache-2.0
    # Copyright (c) Paul Horton. All Rights Reserved.

Migration
=========

.. _v1_v2:

From v1 to v2
-------------

The python package was renamed from ``serializable`` to ``py_serializable``.
Therefore, you need to adjust your imports.

The following shows a quick way to adjust imports in the most efficient way.

.. code-block:: python
   :caption: OLD imports

   import serializable
   from serializable import ViewType, XmlArraySerializationType, XmlStringSerializationType
   from serializable.helpers import BaseHelper, Iso8601Date


.. code-block:: python
   :caption: ADJUSTED imports

   import py_serializable as serializable
   from py_serializable import ViewType, XmlArraySerializationType, XmlStringSerializationType
   from py_serializable.helpers import BaseHelper, Iso8601Date


Also, you might need to adjust the logger access:

.. code-block:: python
   :caption: OLD logger access

   s_logger = logging.getLogger('serializable')


.. code-block:: python
   :caption: NEW logger access

   s_logger = logging.getLogger('py_serializable')