Total Complexity | 52 |
Total Lines | 401 |
Duplicated Lines | 24.44 % |
Changes | 4 | ||
Bugs | 0 | Features | 1 |
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like CapakeyRestGateway often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
1 | # -*- coding: utf-8 -*- |
||
474 | class CapakeyRestGateway(object): |
||
475 | ''' |
||
476 | A REST gateway to the capakey webservice. |
||
477 | ''' |
||
478 | |||
479 | caches = {} |
||
480 | |||
481 | def __init__(self, **kwargs): |
||
482 | self.base_url = kwargs.get( |
||
483 | View Code Duplication | 'base_url', |
|
484 | 'https://geoservices.informatievlaanderen.be/capakey/api/v0.1' |
||
485 | ) |
||
486 | self.base_headers = { |
||
487 | 'Accept': 'application/json' |
||
488 | } |
||
489 | cache_regions = ['permanent', 'long', 'short'] |
||
490 | for cr in cache_regions: |
||
491 | self.caches[cr] = make_region(key_mangler=str) |
||
492 | if 'cache_config' in kwargs: |
||
493 | for cr in cache_regions: |
||
494 | if ('%s.backend' % cr) in kwargs['cache_config']: |
||
495 | log.debug('Configuring %s region on CapakeyRestGateway', cr) |
||
496 | self.caches[cr].configure_from_config( |
||
497 | kwargs['cache_config'], |
||
498 | '%s.' % cr |
||
499 | ) |
||
500 | |||
501 | def list_gemeenten(self, sort=1): |
||
502 | ''' |
||
503 | List all `gemeenten` in Vlaanderen. |
||
504 | |||
505 | :param integer sort: What field to sort on. |
||
506 | :rtype: A :class:`list` of :class:`Gemeente`. |
||
507 | ''' |
||
508 | def creator(): |
||
509 | url = self.base_url + '/municipality' |
||
510 | h = self.base_headers |
||
511 | p = { |
||
512 | 'orderbyCode': sort == 1 |
||
513 | } |
||
514 | res = capakey_rest_gateway_request(url, h, p).json() |
||
515 | return [ |
||
516 | Gemeente(r['municipalityCode'], r['municipalityName']) |
||
517 | for r in res['municipalities'] |
||
518 | ] |
||
519 | if self.caches['permanent'].is_configured: |
||
520 | key = 'list_gemeenten_rest#%s' % sort |
||
521 | gemeente = self.caches['permanent'].get_or_create(key, creator) |
||
522 | else: |
||
523 | gemeente = creator() |
||
524 | for g in gemeente: |
||
525 | g.set_gateway(self) |
||
526 | return gemeente |
||
527 | |||
528 | def get_gemeente_by_id(self, id): |
||
529 | ''' |
||
530 | Retrieve a `gemeente` by id (the NIScode). |
||
531 | |||
532 | :rtype: :class:`Gemeente` |
||
533 | ''' |
||
534 | def creator(): |
||
535 | url = self.base_url + '/municipality/%s' % id |
||
536 | h = self.base_headers |
||
537 | p = { |
||
538 | 'geometry': 'bbox', |
||
539 | 'srs': 31370 |
||
540 | } |
||
541 | res = capakey_rest_gateway_request(url, h, p).json() |
||
542 | return Gemeente( |
||
543 | res['municipalityCode'], |
||
544 | res['municipalityName'], |
||
545 | res['geometry']['center'], |
||
546 | res['geometry']['boundingBox'] |
||
547 | ) |
||
548 | if self.caches['long'].is_configured: |
||
549 | key = 'get_gemeente_by_id_rest#%s' % id |
||
550 | gemeente = self.caches['long'].get_or_create(key, creator) |
||
551 | else: |
||
552 | gemeente = creator() |
||
553 | gemeente.set_gateway(self) |
||
554 | return gemeente |
||
555 | |||
556 | def list_kadastrale_afdelingen(self): |
||
557 | ''' |
||
558 | List all `kadastrale afdelingen` in Flanders. |
||
559 | |||
560 | :param integer sort: Field to sort on. |
||
561 | :rtype: A :class:`list` of :class:`Afdeling`. |
||
562 | ''' |
||
563 | def creator(): |
||
564 | gemeentes = self.list_gemeenten() |
||
565 | res = [] |
||
566 | for g in gemeentes: |
||
567 | res += self.list_kadastrale_afdelingen_by_gemeente(g) |
||
568 | return res |
||
569 | if self.caches['permanent'].is_configured: |
||
570 | key = 'list_afdelingen_rest' |
||
571 | afdelingen = self.caches['permanent'].get_or_create(key, creator) |
||
572 | else: |
||
573 | afdelingen = creator() |
||
574 | return afdelingen |
||
575 | |||
576 | def list_kadastrale_afdelingen_by_gemeente(self, gemeente, sort=1): |
||
577 | ''' |
||
578 | List all `kadastrale afdelingen` in a `gemeente`. |
||
579 | |||
580 | :param gemeente: The :class:`Gemeente` for which the \ |
||
581 | `afdelingen` are wanted. |
||
582 | :param integer sort: Field to sort on. |
||
583 | :rtype: A :class:`list` of :class:`Afdeling`. |
||
584 | ''' |
||
585 | try: |
||
586 | gid = gemeente.id |
||
587 | except AttributeError: |
||
588 | gid = gemeente |
||
589 | gemeente = self.get_gemeente_by_id(gid) |
||
590 | gemeente.clear_gateway() |
||
591 | |||
592 | def creator(): |
||
593 | url = self.base_url + '/municipality/%s/department' % gid |
||
594 | h = self.base_headers |
||
595 | p = { |
||
596 | 'orderbyCode': sort == 1 |
||
597 | } |
||
598 | res = capakey_rest_gateway_request(url, h, p).json() |
||
599 | return [ |
||
600 | Afdeling( |
||
601 | id=r['departmentCode'], |
||
602 | naam=r['departmentName'], |
||
603 | gemeente=gemeente |
||
604 | ) for r in res['departments']] |
||
605 | if self.caches['permanent'].is_configured: |
||
606 | key = 'list_kadastrale_afdelingen_by_gemeente_rest#%s#%s' % (gid, sort) |
||
607 | afdelingen = self.caches['permanent'].get_or_create(key, creator) |
||
608 | else: |
||
609 | afdelingen = creator() |
||
610 | for a in afdelingen: |
||
611 | a.set_gateway(self) |
||
612 | return afdelingen |
||
613 | |||
614 | def get_kadastrale_afdeling_by_id(self, aid): |
||
615 | ''' |
||
616 | Retrieve a 'kadastrale afdeling' by id. |
||
617 | |||
618 | :param aid: An id of a `kadastrale afdeling`. |
||
619 | :rtype: A :class:`Afdeling`. |
||
620 | ''' |
||
621 | def creator(): |
||
622 | url = self.base_url + '/department/%s' % (aid) |
||
623 | h = self.base_headers |
||
624 | p = { |
||
625 | 'geometry': 'bbox', |
||
626 | 'srs': 31370 |
||
627 | } |
||
628 | res = capakey_rest_gateway_request(url, h, p).json() |
||
629 | return Afdeling( |
||
630 | id=res['departmentCode'], |
||
631 | naam=res['departmentName'], |
||
632 | gemeente=Gemeente(res['municipalityCode'], res['municipalityName']), |
||
633 | centroid=res['geometry']['center'], |
||
634 | bounding_box=res['geometry']['boundingBox'] |
||
635 | ) |
||
636 | if self.caches['long'].is_configured: |
||
637 | key = 'get_kadastrale_afdeling_by_id_rest#%s' % aid |
||
638 | afdeling = self.caches['long'].get_or_create(key, creator) |
||
639 | else: |
||
640 | afdeling = creator() |
||
641 | afdeling.set_gateway(self) |
||
642 | return afdeling |
||
643 | |||
644 | def list_secties_by_afdeling(self, afdeling): |
||
645 | ''' |
||
646 | List all `secties` in a `kadastrale afdeling`. |
||
647 | |||
648 | :param afdeling: The :class:`Afdeling` for which the `secties` are \ |
||
649 | wanted. Can also be the id of and `afdeling`. |
||
650 | :rtype: A :class:`list` of `Sectie`. |
||
651 | ''' |
||
652 | try: |
||
653 | aid = afdeling.id |
||
654 | gid = afdeling.gemeente.id |
||
655 | except AttributeError: |
||
656 | aid = afdeling |
||
657 | afdeling = self.get_kadastrale_afdeling_by_id(aid) |
||
658 | gid = afdeling.gemeente.id |
||
659 | afdeling.clear_gateway() |
||
660 | |||
661 | def creator(): |
||
662 | View Code Duplication | url = self.base_url + '/municipality/%s/department/%s/section' % (gid, aid) |
|
663 | h = self.base_headers |
||
664 | res = capakey_rest_gateway_request(url, h).json() |
||
665 | return [ |
||
666 | Sectie( |
||
667 | r['sectionCode'], |
||
668 | afdeling |
||
669 | ) for r in res['sections'] |
||
670 | ] |
||
671 | if self.caches['long'].is_configured: |
||
672 | key = 'list_secties_by_afdeling_rest#%s' % aid |
||
673 | secties = self.caches['long'].get_or_create(key, creator) |
||
674 | else: |
||
675 | secties = creator() |
||
676 | for s in secties: |
||
677 | s.set_gateway(self) |
||
678 | return secties |
||
679 | |||
680 | def get_sectie_by_id_and_afdeling(self, id, afdeling): |
||
681 | ''' |
||
682 | Get a `sectie`. |
||
683 | |||
684 | :param id: An id of a sectie. eg. "A" |
||
685 | :param afdeling: The :class:`Afdeling` for in which the `sectie` can \ |
||
686 | be found. Can also be the id of and `afdeling`. |
||
687 | :rtype: A :class:`Sectie`. |
||
688 | ''' |
||
689 | try: |
||
690 | aid = afdeling.id |
||
691 | except AttributeError: |
||
692 | aid = afdeling |
||
693 | afdeling = self.get_kadastrale_afdeling_by_id(aid) |
||
694 | afdeling.clear_gateway() |
||
695 | |||
696 | def creator(): |
||
697 | url = self.base_url + '/municipality/%s/department/%s/section/%s' % (afdeling.gemeente.id, afdeling.id, id) |
||
698 | h = self.base_headers |
||
699 | p = { |
||
700 | 'geometry': 'bbox', |
||
701 | 'srs': 31370 |
||
702 | } |
||
703 | res = capakey_rest_gateway_request(url, h, p).json() |
||
704 | return Sectie( |
||
705 | res['sectionCode'], |
||
706 | afdeling, |
||
707 | res['geometry']['center'], |
||
708 | res['geometry']['boundingBox'], |
||
709 | ) |
||
710 | if self.caches['long'].is_configured: |
||
711 | key = 'get_sectie_by_id_and_afdeling_rest#%s#%s' % (id, aid) |
||
712 | sectie = self.caches['long'].get_or_create(key, creator) |
||
713 | else: |
||
714 | sectie = creator() |
||
715 | sectie.set_gateway(self) |
||
716 | return sectie |
||
717 | |||
718 | def parse_percid(self, capakey): |
||
719 | import re |
||
720 | match = re.match( |
||
721 | r"^([0-9]{5})([A-Z]{1})([0-9]{4})\/([0-9]{2})([A-Z\_]{1})([0-9]{3})$", |
||
722 | capakey |
||
723 | ) |
||
724 | if match: |
||
725 | percid = match.group(1) + '_' + match.group(2) +\ |
||
726 | '_' + match.group(3) + '_' + match.group(5) + '_' +\ |
||
727 | match.group(6) + '_' + match.group(4) |
||
728 | return percid |
||
729 | else: |
||
730 | raise ValueError( |
||
731 | "Invalid Capakey %s can't be parsed" % capakey |
||
732 | View Code Duplication | ) |
|
733 | |||
734 | def parse_capakey(self, percid): |
||
735 | import re |
||
736 | match = re.match( |
||
737 | r"^([0-9]{5})_([A-Z]{1})_([0-9]{4})_([A-Z\_]{1})_([0-9]{3})_([0-9]{2})$", |
||
738 | percid |
||
739 | ) |
||
740 | if match: |
||
741 | capakey = match.group(1) + match.group(2) +\ |
||
742 | match.group(3) + '/' + match.group(5) + '_' +\ |
||
743 | match.group(6) + '_' + match.group(4) |
||
744 | return capakey |
||
745 | else: |
||
746 | raise ValueError( |
||
747 | "Invalid percid %s can't be parsed" % percid |
||
748 | ) |
||
749 | |||
750 | def list_percelen_by_sectie(self, sectie): |
||
751 | ''' |
||
752 | List all percelen in a `sectie`. |
||
753 | |||
754 | :param sectie: The :class:`Sectie` for which the percelen are wanted. |
||
755 | :param integer sort: Field to sort on. |
||
756 | :rtype: A :class:`list` of :class:`Perceel`. |
||
757 | ''' |
||
758 | sid = sectie.id |
||
759 | aid = sectie.afdeling.id |
||
760 | gid = sectie.afdeling.gemeente.id |
||
761 | sectie.clear_gateway() |
||
762 | def creator(): |
||
763 | url = self.base_url + '/municipality/%s/department/%s/section/%s/parcel' % (gid, aid, sid) |
||
764 | h = self.base_headers |
||
765 | p = { |
||
766 | 'data': 'cadmap' |
||
767 | } |
||
768 | res = capakey_rest_gateway_request(url, h, p).json() |
||
769 | return [ |
||
770 | Perceel( |
||
771 | r['perceelnummer'], |
||
772 | sectie, |
||
773 | r['capakey'], |
||
774 | self.parse_percid(r['capakey']), |
||
775 | ) for r in res['parcels'] |
||
776 | ] |
||
777 | if self.caches['short'].is_configured: |
||
778 | key = 'list_percelen_by_sectie_rest#%s#%s#%s' % (gid, aid, sid) |
||
779 | percelen = self.caches['short'].get_or_create(key, creator) |
||
780 | else: |
||
781 | percelen = creator() |
||
782 | for p in percelen: |
||
783 | p.set_gateway(self) |
||
784 | return percelen |
||
785 | |||
786 | def get_perceel_by_id_and_sectie(self, id, sectie): |
||
787 | ''' |
||
788 | Get a `perceel`. |
||
789 | |||
790 | :param id: An id for a `perceel`. |
||
791 | :param sectie: The :class:`Sectie` that contains the perceel. |
||
792 | :rtype: :class:`Perceel` |
||
793 | ''' |
||
794 | sid = sectie.id |
||
795 | aid = sectie.afdeling.id |
||
796 | gid = sectie.afdeling.gemeente.id |
||
797 | sectie.clear_gateway() |
||
798 | def creator(): |
||
799 | url = self.base_url + '/municipality/%s/department/%s/section/%s/parcel/%s' % (gid, aid, sid, id) |
||
800 | h = self.base_headers |
||
801 | p = { |
||
802 | 'geometry': 'bbox', |
||
803 | 'srs': 31370, |
||
804 | 'data': 'cadmap' |
||
805 | } |
||
806 | res = capakey_rest_gateway_request(url, p, h).json() |
||
807 | return Perceel( |
||
808 | res['perceelnummer'], |
||
809 | sectie, |
||
810 | res['capakey'], |
||
811 | Perceel.get_percid_from_capakey(res['capakey']), |
||
812 | None, |
||
813 | None, |
||
814 | res['geometry']['center'], |
||
815 | res['geometry']['boundingBox'] |
||
816 | ) |
||
817 | if self.caches['short'].is_configured: |
||
818 | key = 'get_perceel_by_id_and_sectie_rest#%s#%s#%s' % (id, sectie.id, sectie.afdeling.id) |
||
819 | perceel = self.caches['short'].get_or_create(key, creator) |
||
820 | else: |
||
821 | perceel = creator() |
||
822 | perceel.set_gateway(self) |
||
823 | return perceel |
||
824 | |||
825 | def get_perceel_by_capakey(self, capakey): |
||
826 | ''' |
||
827 | Get a `perceel`. |
||
828 | |||
829 | :param capakey: An capakey for a `perceel`. |
||
830 | :rtype: :class:`Perceel` |
||
831 | ''' |
||
832 | def creator(): |
||
833 | url = self.base_url + '/parcel/%s' % capakey |
||
834 | h = self.base_headers |
||
835 | p = { |
||
836 | 'geometry': 'bbox', |
||
837 | 'srs': 31370, |
||
838 | 'data': 'cadmap' |
||
839 | } |
||
840 | res = capakey_rest_gateway_request(url, p, h).json() |
||
841 | return Perceel( |
||
842 | res['perceelnummer'], |
||
843 | Sectie( |
||
844 | res['sectionCode'], |
||
845 | Afdeling( |
||
846 | res['departmentCode'], |
||
847 | res['departmentName'], |
||
848 | Gemeente(res['municipalityCode'], res['municipalityName']) |
||
849 | ) |
||
850 | ), |
||
851 | res['capakey'], |
||
852 | Perceel.get_percid_from_capakey(res['capakey']), |
||
853 | None, |
||
854 | None, |
||
855 | res['geometry']['center'], |
||
856 | res['geometry']['boundingBox'] |
||
857 | ) |
||
858 | if self.caches['short'].is_configured: |
||
859 | key = 'get_perceel_by_capakey_rest#%s' % capakey |
||
860 | perceel = self.caches['short'].get_or_create(key, creator) |
||
861 | else: |
||
862 | perceel = creator() |
||
863 | perceel.set_gateway(self) |
||
864 | return perceel |
||
865 | |||
866 | def get_perceel_by_percid(self, percid): |
||
867 | ''' |
||
868 | Get a `perceel`. |
||
869 | |||
870 | :param percid: A percid for a `perceel`. |
||
871 | :rtype: :class:`Perceel` |
||
872 | ''' |
||
873 | return self.get_perceel_by_capakey( |
||
874 | Perceel.get_capakey_from_percid(percid) |
||
875 | ) |
||
1283 |