Welcome | Get started | Dive | Contribute | Topics | Reference | Changes | More
addresses : Multiple addresses per partner¶
The lino_xl.lib.addresses plugin adds functionality to handle multiple
addresses per partner. When this plugin is installed, your application
gets a “Manage addresses” button in the overview field of a partner.
Side note: Code snippets (lines starting with >>>) in this document get
tested as part of our development workflow. The following
initialization snippet tells you which demo project is being used in
this document.
>>> from lino import startup
>>> startup('lino_book.projects.min9.settings')
>>> from lino.api.doctest import *
>>> from django.db.models import Q
Plugin configuration¶
- addresses.partner_model¶
The database model used for the
Address.partnerfield.The default value is
'contacts.Partner'.This is a str at configuration but will be resolved during startup.
>>> dd.plugins.addresses.partner_model <class 'lino_book.projects.min9.modlib.contacts.models.Partner'>
Examples¶
>>> rt.show(addresses.Addresses)
...
=================================== ==================== ======== ===================================================== ========= ==================
Partner Address type Remark Address Primary Data source
----------------------------------- -------------------- -------- ----------------------------------------------------- --------- ------------------
Bäckerei Ausdemwald Official address Vervierser Straße 45, 4700 Eupen Yes Manually entered
Bäckerei Ausdemwald Official address Aachener Straße 1 No Manually entered
Bäckerei Mießen Official address Gospert 103, 4700 Eupen Yes Manually entered
Bäckerei Mießen Unverified address Akazienweg 2 No Manually entered
Arens Andreas Official address Akazienweg, 4700 Eupen Yes Manually entered
Arens Andreas Declared address Alter Malmedyer Weg 4 No Manually entered
Arens Annette Official address Alter Malmedyer Weg, 4700 Eupen Yes Manually entered
Arens Annette Reference address Am Bahndamm 5 No Manually entered
Ausdemwald Alfons Official address Am Bahndamm, 4700 Eupen Yes Manually entered
Ausdemwald Alfons Obsolete Am Berg 7 No Manually entered
...
Denon Denis Official address Paris, France Yes Manually entered
Jeanémart Jérôme Official address Paris, France Yes Manually entered
AS Express Post Official address Peterburi tee 34/5, 11415 Tallinn, Estonia Yes Manually entered
AS Matsalu Veevärk Official address Estonia Yes Manually entered
Eesti Energia AS Official address Estonia Yes Manually entered
IIZI kindlustusmaakler AS Official address Estonia Yes Manually entered
Maksu- ja Tolliamet Official address Lõõtsa 8a, 15176 Tallinn, Estonia Yes Manually entered
Ragn-Sells AS Official address Suur-Sõjamäe 50 a, 11415 Tallinn, Estonia Yes Manually entered
Electrabel Customer Solutions Official address Boulevard Simón Bolívar 34, 1000 Brussels Yes Manually entered
Ethias s.a. Official address Rue des Croisiers 24, 4000 Liège Yes Manually entered
Leffin Electronics Official address Schilsweg 80, 4700 Eupen Yes Manually entered
=================================== ==================== ======== ===================================================== ========= ==================
The primary address is shown in the partner’s overview field:
>>> obj = contacts.Partner.objects.get(name="Arens Andreas")
>>> print(to_rst(contacts.Partners.request().get_data_value(obj, 'overview')))
See as Organization, **Partner**, Household
**Arens Andreas**
Akazienweg
4700 Eupen[Manage addresses]
`andreas@arens.com <mailto:andreas@arens.com>`__, `+32 87123456 <tel:+32 87123456>`__ [Contact details]
When you click on [Manage addresses] you see:
>>> rt.show(addresses.AddressesByPartner, obj)
...
================== ======== ======================== =========
Address type Remark Address Primary
------------------ -------- ------------------------ ---------
Official address Akazienweg, 4700 Eupen Yes
Declared address Alter Malmedyer Weg 4 No
================== ======== ======================== =========
>>> rt.show(addresses.AddressTypes)
======= ============ ====================
value name text
------- ------------ --------------------
01 official Official address
02 unverified Unverified address
03 declared Declared address
04 reference Reference address
98 obsolete Obsolete
99 other Other
======= ============ ====================
>>> rt.show(addresses.DataSources)
======= ========== ==================
value name text
------- ---------- ------------------
01 manually Manually entered
02 eid Read from eID
======= ========== ==================
Database models¶
- class lino_xl.lib.addresses.Address¶
Django model to represent an address record.
- partner¶
The owner of this address record. This is business partner to whom this address applies.
- primary¶
Whether this address is the primary address of its owner. Setting this field will automatically uncheck any previousl primary addresses and update the owner’s address fields.
- address_type¶
The type of this address record.
A pointer to
AddressTypes. The default value isAddressTypes.official.
- data_source¶
Pointer to
DataSources.Specifies how this information entered into our database.
Data tables¶
- class lino_xl.lib.addresses.Addresses¶
Shows all addresses in the database.
Filter parameters:
- partner¶
Show only addresses of the given partner in
Address.partner.
- place¶
Show only addresses having the given place in
Address.city.
- address_type¶
Show only addresses having the given type.
- class lino_xl.lib.addresses.AddressesByPartner¶
Shows all addresses of this partner.
Choicelists¶
- class lino_xl.lib.addresses.AddressTypes¶
A choicelist with all available address types.
>>> rt.show(addresses.AddressTypes) ======= ============ ==================== value name text ------- ------------ -------------------- 01 official Official address 02 unverified Unverified address 03 declared Declared address 04 reference Reference address 98 obsolete Obsolete 99 other Other ======= ============ ====================
- class lino_xl.lib.addresses.DataSources¶
A choicelist with all available data sources.
>>> rt.show(addresses.DataSources) ======= ========== ================== value name text ------- ---------- ------------------ 01 manually Manually entered 02 eid Read from eID ======= ========== ==================
Tests¶
Some unit test cases are
lino.projects.min2.tests.test_addresses.
This is also covered by the manual testing suite (Multiple addresses).
Data check on addresses¶
The AddressOwnerChecker detects inconsistencies between the address on
the owner (partner) and its collection of addresses. Theoretically things are
easy: the partner’s address fields contain a copy of the partner’s primary
address. But bugs and other circumstances can lead to inconsistencies. And when
you have thousands of addresses, you don’t want to get bothered by problems that
might get fixed automatically. Quite sophisticated task though, because Lino
must not loose any data and must not “fix” problems for which actually a human
is needed.
- class lino_xl.lib.addresses.AddressOwnerChecker¶
Checks for the data problems described below.
Here is a utility function used to describe and test the possible data problems and how Lino handles them. The remaining part of this section will call this function over and over again. For each test it creates a partner and a list of addresses, then runs the data checker to detect problems, then prints the problem message and a summary of the database content after fixing them before cleaning up the database. Most addresses have just a street name to simplify things.
>>> from lino_xl.lib.contacts.utils import street2kw
>>> checker = rt.models.addresses.AddressOwnerChecker.self
>>> PK = 1234
>>> Partner = dd.plugins.addresses.partner_model
>>> Address = rt.models.addresses.Address
>>> def p(street="", **kwargs):
... return Partner(pk=PK, name="x", **street2kw(street, **kwargs))
>>> def a(street="", primary=False, **kwargs):
... return Address(primary=primary, **street2kw(street, **kwargs))
>>> def test(partner, *addresses):
... # delete all db objects:
... Address.objects.filter(partner_id=PK).delete()
... Partner.objects.filter(id=PK).delete()
... # store partner and addresses:
... partner.save()
... for a in addresses:
... a.partner = partner
... a.save()
... for (fixable, msg) in checker.get_checkdata_problems(partner, fix=True):
... print(("(*) " if fixable else "") + str(msg))
... print(', '.join(Partner.objects.get(pk=PK).address_location_lines()))
... for addr in Address.objects.filter(partner_id=PK):
... print("- " + ("primary " if addr.primary else "") + ', '.join(addr.address_location_lines()))
... Address.objects.filter(partner_id=PK).delete()
... Partner.objects.filter(id=PK).delete()
>>> test(p("foo"))
(*) Primary address is missing.
foo
- primary foo
When the partner has some non-empty address field and there is no
Address object that matches this address, Lino fixes this by creating
an address record from these.
>>> test(p("foo"), a("bar"))
(*) Primary address is missing.
foo
- bar
- primary foo
The Unique address is not marked primary. means that there is
exactly one Address object, which matches the partner and just fails to
be marked as primary, mark it as primary and return it.
>>> test(p("foo"), a("foo"))
(*) Unique address is not marked primary.
foo
- primary foo
Multiple primary addresses are not allowed. If one of them matches the partner, Lino can fix it by removing primary from the others:
>>> test(p("foo"), a("foo", True), a("bar", True))
(*) Multiple primary addresses.
foo
- primary foo
- bar
But if none of them matches the partner, Lino cannot fix the issue:
>>> test(p("foo"), a("bar", True), a("baz", True))
Multiple primary addresses.
foo
- primary bar
- primary baz
>>> test(p("foo"), a("bar", True))
Primary address differs from owner address (street:foo->bar).
foo
- primary bar
>>> test(p("foo"), a("", True))
(*) Must sync owner to address.
foo
- primary foo
When the only address is overwritable but not marked primary, Lino will set it to primary.
>>> test(p("foo"), a(""))
(*) Must sync owner to address.
foo
- primary foo
Two addresses, but the wrong one is marked primary:
>>> test(p("foo"), a("bar", True), a("foo"))
(*) Matching address is not marked primary.
foo
- bar
- primary foo
When exactly one addresses matches the partner, it becomes primary and potentially gets synchronized if it is incomplete.
>>> test(p("foo"), a("bar"), a("foo"))
(*) Matching address is not marked primary.
foo
- bar
- primary foo
>>> test(p("foo"), a("foo"), a("bar"))
(*) Matching address is not marked primary.
foo
- primary foo
- bar
When the address record just lacks some field, Lino can update it.
>>> test(p("foo", addr2="foo2"), a("foo"), a("bar"))
(*) Primary address is not complete
(*) Matching address is not marked primary.
foo, foo2
- primary foo, foo2
- bar
When no address record matches:
>>> test(p("foo"), a("bar"), a("baz"))
(*) Primary address is missing.
foo
- bar
- baz
- primary foo
When more than one address record matches:
>>> test(p("foo"), a("foo"), a("foo"))
No primary address, but matching addresses exist.
foo
- foo
- foo
The wrong address is marked as primary:
>>> test(p("foo"), a("foo"), a("bar"), a("baz", True))
(*) Matching address is not marked primary.
foo
- primary foo
- bar
- baz
When the partner’s address is empty, we can have as many addresses as we want as long as none of them is marked primary.
>>> test(p())
>>> test(p(""), a("bar"))
- bar
>>> test(p(""), a("foo"), a("bar"))
- foo
- bar