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