vos-data-utils 1.0.6__tar.gz → 1.0.7__tar.gz

{vos_data_utils-1.0.6 → vos_data_utils-1.0.7}/PKG-INFO

@@ -1,18 +1,17 @@
 Metadata-Version: 2.1
 Name: vos-data-utils
-Version: 1.0.6
+Version: 1.0.7
 Summary: description
 Author: ValueOfSpace
 Author-email: dev@valueofspace.com
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.7
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: symspellpy
 Requires-Dist: pandas
@@ -118,7 +117,22 @@ vos-data-utils is a shared utility library essential for 'Value of Space' data w
 <div style="color: gray;">
 
 -   업데이트
-    -   날짜 빈도 dictionary 위치 오류 수정
+    -   날짜 빈도 dictionary 경로 업데이트
+
+</details>
+<details>
+<summary><strong>Version 1.0.7 - 2025.01</strong></summary>
+
+<div style="color: gray;">
+
+-   업데이트
+    -   convaddr 모듈 업데이트
+        -   지번 주소 중 '외 필지' 와 같은 다중 지번과 관련된 문자열 필터링 추가
+        -   유닛 테스트 코드(`test_convaddr`) 업데이트
+    -   genpnu 모듈 업데이트
+        -   지번 주소를 입력받아 pnu로 변환하는 기능 및 보조 기능 추가
+        -   유닛 테스트 코드(`test_genpnu`) 업데이트
+    -   날짜 빈도 dictionary 경로 업데이트
 
 </details>
 </br>
@@ -391,6 +405,28 @@ pip install vos-data-utils
 <summary><strong>Show instructions</strong></summary>
 <br></br>
 
+**`convaddr.replace_etc_land_string`**
+
+-   입력된 주소 문자열(한글로 이루어진 지번 체계 주소)의 번지('0000-0000')와 '외 필지' 가 결합되어 있을 경우 '외' 앞에 공백을 추가하여 분리된 문자열로 리턴
+-   Example
+
+    -   Run
+
+        ```python
+        from vdutils import convaddr
+
+        CA = convaddr.ConvAddr()
+        print(CA.replace_etc_land_string(addr="서울시 강남구 삼성동 1외 1필지"))
+        ```
+
+    -   Output
+
+        ```python
+        서울시 강남구 삼성동 1 외 1필지
+        ```
+
+</br>
+
 **`convaddr.correct_simple_spacing`**
 
 -   입력된 주소 문자열(한글로 이루어진 지번 체계 주소)의 2개 이상의 연속된 공백을 단일 공백으로 변환하여 리턴
@@ -508,6 +544,8 @@ pip install vos-data-utils
         print(CA.correct_bjd(addr="강원도 춘천시 서면 현암리 1-1", is_log=False))
         print(CA.correct_bjd(addr="강원도 춘천시 서면 현암리1-1", is_log=False))
         print(CA.correct_bjd(addr="강원도   춘천시 서면 현암리 1-1", is_log=False))
+        print(CA.correct_bjd(addr="강원도 춘천시 서면 현암리 1-1외 1필지", is_log=False))
+        print(CA.correct_bjd(addr="강원도 춘천시 서면 현암리 1-1 외 1필지", is_log=False))
         ```
 
     -   Output
@@ -519,6 +557,8 @@ pip install vos-data-utils
         강원특별자치도 춘천시 서면 현암리 1-1
         강원특별자치도 춘천시 서면 현암리 1-1
         강원특별자치도 춘천시 서면 현암리 1-1
+        강원특별자치도 춘천시 서면 현암리 1-1 외 1필지
+        강원특별자치도 춘천시 서면 현암리 1-1 외 1필지
         ```
 
     </details><br>
@@ -1025,7 +1065,7 @@ pip install vos-data-utils
         {'error': False,
         'bjd_cd': '1168010500',
         'deleted_dt': None,
-        'base_dt': '2024-01-18',
+        'base_dt': '{base_dt}',
         'msg': ''}
         ```
 
@@ -1044,7 +1084,7 @@ pip install vos-data-utils
         {'error': True,
         'bjd_cd': None,
         'deleted_dt': None,
-        'base_dt': '2024-01-18',
+        'base_dt': '{base_dt}',
         'msg': "'부산광역시 강남구 삼성동' is not a valid legal district name"}
         ```
 
@@ -1077,7 +1117,7 @@ pip install vos-data-utils
         'full_bjd_nm': '서울특별시 강남구 삼성동',
         'created_dt': '1988-04-23',
         'deleted_dt': None,
-        'base_dt': '2024-01-18',
+        'base_dt': '{base_dt}',
         'msg': ''}
         ```
 
@@ -1101,7 +1141,7 @@ pip install vos-data-utils
         'full_bjd_nm': None,
         'created_dt': None,
         'deleted_dt': None,
-        'base_dt': '2024-01-18',
+        'base_dt': '{base_dt}',
         'msg': "'1234567890' is not a valid legal district code"}
         ```
 
@@ -1127,8 +1167,8 @@ pip install vos-data-utils
         from vdutils.genpnu import GenPnu
 
         GP = GenPnu()
-        GP.generate_pnu_from_bjd_nm(
-            bjd_nm='1168010500',
+        GP.generate_pnu(
+            bjd_cd='1168010500',
             jibun='1-1'
         ) # 정상적인 법정동코드, 지번 입력
 
@@ -1142,20 +1182,22 @@ pip install vos-data-utils
         'bjd_cd': '1168010500',
         'mountain_cd': '1',
         'bunji_cd': '00010001',
-        'bjd_datas': {'error': False,
-        'sido_nm': '서울특별시',
-        'sgg_nm': '강남구',
-        'emd_nm': '삼성동',
-        'ri_nm': None,
-        'full_bjd_nm': '서울특별시 강남구 삼성동',
-        'created_dt': '1988-04-23',
-        'deleted_dt': None,
-        'base_dt': '2024-01-18',
-        'msg': ''},
+        'bjd_datas': {
+            'error': False,
+            'sido_nm': '서울특별시',
+            'sgg_nm': '강남구',
+            'emd_nm': '삼성동',
+            'ri_nm': None,
+            'full_bjd_nm': '서울특별시 강남구 삼성동',
+            'created_dt': '1988-04-23',
+            'deleted_dt': None,
+            'base_dt': '{base_dt}',
+            'msg': ''
+        },
         'bun': '1',
         'ji': '1',
-        'msg': '',
-        'base_dt': '2024-01-18'}
+        'base_dt': '{base_dt}',
+        'msg': ''}
         ```
 
     -   Run
@@ -1174,24 +1216,26 @@ pip install vos-data-utils
 
         ```
         {'error': True,
-        'pnu': '1234567890100000000',
-        'bjd_cd': '1234567890',
-        'mountain_cd': '1',
-        'bunji_cd': '00000000',
-        'bjd_datas': {'error': True,
-        'sido_nm': None,
-        'sgg_nm': None,
-        'emd_nm': None,
-        'ri_nm': None,
-        'full_bjd_nm': None,
-        'created_dt': None,
-        'deleted_dt': None,
-        'base_dt': '2024-01-18',
-        'msg': "'1234567890' is not a valid legal district code"},
-        'bun': '0',
-        'ji': '0',
-        'msg': '블록지번',
-        'base_dt': '2024-01-18'}
+        'pnu': None,
+        'bjd_cd': None,
+        'mountain_cd': None,
+        'bunji_cd': None,
+        'bjd_datas': {
+            'error': True,
+            'sido_nm': None,
+            'sgg_nm': None,
+            'emd_nm': None,
+            'ri_nm': None,
+            'full_bjd_nm': None,
+            'created_dt': None,
+            'deleted_dt': None,
+            'base_dt': '{base_dt}',
+            'msg': "'1234567890' is not a valid legal district code"
+        },
+        'bun': None,
+        'ji': None,
+        'base_dt': '{base_dt}',
+        'msg': "'1234567890' is not a valid legal district code"}
         ```
 
     -   Run
@@ -1214,20 +1258,22 @@ pip install vos-data-utils
         'bjd_cd': '1168010500',
         'mountain_cd': '1',
         'bunji_cd': '00000000',
-        'bjd_datas': {'error': False,
-        'sido_nm': '서울특별시',
-        'sgg_nm': '강남구',
-        'emd_nm': '삼성동',
-        'ri_nm': None,
-        'full_bjd_nm': '서울특별시 강남구 삼성동',
-        'created_dt': '1988-04-23',
-        'deleted_dt': None,
-        'base_dt': '2024-01-18',
-        'msg': ''},
+        'bjd_datas': {
+            'error': False,
+            'sido_nm': '서울특별시',
+            'sgg_nm': '강남구',
+            'emd_nm': '삼성동',
+            'ri_nm': None,
+            'full_bjd_nm': '서울특별시 강남구 삼성동',
+            'created_dt': '1988-04-23',
+            'deleted_dt': None,
+            'base_dt': '{base_dt}',
+            'msg': ''
+        },
         'bun': '0',
         'ji': '0',
         'msg': '블록지번',
-        'base_dt': '2024-01-18'}
+        'base_dt': '{base_dt}'}
         ```
 
 **`genpnu.generate_pnu_from_bjd_nm`**
@@ -1264,20 +1310,22 @@ pip install vos-data-utils
         'bjd_cd': '1168010500',
         'mountain_cd': '2',
         'bunji_cd': '10001000',
-        'bjd_datas': {'error': False,
-        'sido_nm': '서울특별시',
-        'sgg_nm': '강남구',
-        'emd_nm': '삼성동',
-        'ri_nm': None,
-        'full_bjd_nm': '서울특별시 강남구 삼성동',
-        'created_dt': '1988-04-23',
-        'deleted_dt': None,
-        'base_dt': '2024-01-18',
-        'msg': ''},
+        'bjd_datas': {
+            'error': False,
+            'sido_nm': '서울특별시',
+            'sgg_nm': '강남구',
+            'emd_nm': '삼성동',
+            'ri_nm': None,
+            'full_bjd_nm': '서울특별시 강남구 삼성동',
+            'created_dt': '1988-04-23',
+            'deleted_dt': None,
+            'base_dt': '{base_dt}',
+            'msg': ''
+        },
         'bun': '1000',
         'ji': '1000',
-        'msg': '',
-        'base_dt': '2024-01-18'}
+        'base_dt': '{base_dt}',
+        'msg': ''}
         ```
 
     -   Run
@@ -1300,11 +1348,22 @@ pip install vos-data-utils
         'bjd_cd': None,
         'mountain_cd': None,
         'bunji_cd': None,
-        'bjd_datas': None,
+        'bjd_datas': {
+            'error': True,
+            'sido_nm': None,
+            'sgg_nm': None,
+            'emd_nm': None,
+            'ri_nm': None,
+            'full_bjd_nm': None,
+            'created_dt': None,
+            'deleted_dt': None,
+            'base_dt': '{base_dt}',
+            'msg': ''
+        },
         'bun': None,
         'ji': None,
-        'msg': "올바르지 않은 법정동명('부산광역시 강남구 삼성동' is not a valid legal district name)",
-        'base_dt': '2024-01-18'}
+        'base_dt': '{base_dt}',
+        'msg': "'부산광역시 강남구 삼성동' is not a valid legal district name"}
         ```
 
     -   Run
@@ -1323,24 +1382,151 @@ pip install vos-data-utils
 
         ```
         {'error': True,
-        'pnu': '1168010500100000000',
+        'pnu': None,
+        'bjd_cd': None,
+        'mountain_cd': None,
+        'bunji_cd': None,
+        'bjd_datas': {
+            'error': True,
+            'sido_nm': None,
+            'sgg_nm': None,
+            'emd_nm': None,
+            'ri_nm': None,
+            'full_bjd_nm': None,
+            'created_dt': None,
+            'deleted_dt': None,
+            'base_dt': '{base_dt}',
+            'msg': ''
+        },
+        'bun': None,
+        'ji': None,
+        'base_dt': '{base_dt}',
+        'msg': "Invalid 'jibun' format. Please follow the specified format."}
+        ```
+
+**`genpnu.generate_pnu_from_address`**
+
+-   입력된 문자열(주소)을 필지관리번호(pnu)로 변환하여 반환
+-   입력 문자열(주소)은 지번 주소 규칙을 기반으로 해야하며 string 타입이어야 함
+-   번지는 '산'을 포함한 본번과 부번이 결합된 문자열이어야 하며 본번과 부번은 최대 4자리의 숫자 문자열이어야 함. 본번과 부번은 '-' 으로 구분함
+-   입력 문자열 중 지번에서 '산'과 번지 사이에 공백 유무는 상관없으며 지번의 올바른 형식은 다음과 같음
+    -   산 0000-0000 (산0000-0000)
+    -   산 0000 (산0000)
+    -   0000-0000
+    -   0000
+-   입력된 문자열의 타입과 형식 오류는 예외 처리되나 이 외의 경우 예외형식의 응답을 반환하며 error, msg 를 통해 예외유무를 확인할 수 있음
+
+-   Example
+
+    -   Run
+
+        ```python
+        from vdutils.genpnu import GenPnu
+
+        GP = GenPnu()
+        GP.generate_pnu_from_address(
+            address='서울특별시 강남구 삼성동 산 1000-1000'
+        ) # 정상적인 법정동명, 지번 입력
+        ```
+
+    -   Output
+
+        ```
+        {'error': False,
+        'pnu': '1168010500210001000',
         'bjd_cd': '1168010500',
-        'mountain_cd': '1',
-        'bunji_cd': '00000000',
-        'bjd_datas': {'error': False,
-        'sido_nm': '서울특별시',
-        'sgg_nm': '강남구',
-        'emd_nm': '삼성동',
-        'ri_nm': None,
-        'full_bjd_nm': '서울특별시 강남구 삼성동',
-        'created_dt': '1988-04-23',
-        'deleted_dt': None,
-        'base_dt': '2024-01-18',
-        'msg': ''},
-        'bun': '0',
-        'ji': '0',
-        'msg': '블록지번',
-        'base_dt': '2024-01-18'}
+        'mountain_cd': '2',
+        'bunji_cd': '10001000',
+        'bjd_datas': {
+            'error': False,
+            'sido_nm': '서울특별시',
+            'sgg_nm': '강남구',
+            'emd_nm': '삼성동',
+            'ri_nm': None,
+            'full_bjd_nm': '서울특별시 강남구 삼성동',
+            'created_dt': '1988-04-23',
+            'deleted_dt': None,
+            'base_dt': '{base_dt}',
+            'msg': ''
+        },
+        'bun': '1000',
+        'ji': '1000',
+        'base_dt': '{base_dt}',
+        'msg': ''}
+        ```
+
+    -   Run
+
+        ```python
+        from vdutils.genpnu import GenPnu
+
+        GP = GenPnu()
+        GP.generate_pnu_from_address(
+            address='부산광역시 강남구 삼성동 산 1000-1000'
+        ) # 존재하지 않는 법정동명, 정상적인 지번 입력
+        ```
+
+    -   Output
+
+        ```
+        {'error': True,
+        'pnu': None,
+        'bjd_cd': None,
+        'mountain_cd': None,
+        'bunji_cd': None,
+        'bjd_datas': {
+            'error': True,
+            'sido_nm': None,
+            'sgg_nm': None,
+            'emd_nm': None,
+            'ri_nm': None,
+            'full_bjd_nm': None,
+            'created_dt': None,
+            'deleted_dt': None,
+            'base_dt': '{base_dt}',
+            'msg': ''
+        },
+        'bun': None,
+        'ji': None,
+        'base_dt': '{base_dt}',
+        'msg': 'Failed to extract bjd name from address: 부산광역시 강남구 삼성동 산 1000-1000'}
+        ```
+
+    -   Run
+
+        ```python
+        from vdutils.genpnu import GenPnu
+
+        GP = GenPnu()
+        GP.generate_pnu_from_address(
+            address = '서울특별시 강남구 삼성동 10000'
+        ) # 정상적인 법정동코드, 비정상적인 지번 입력
+        ```
+
+    -   Output
+
+        ```
+        {'error': True,
+        'pnu': None,
+        'bjd_cd': None,
+        'mountain_cd': None,
+        'bunji_cd': None,
+        'bjd_datas': {
+            'error': True,
+            'sido_nm': None,
+            'sgg_nm': None,
+            'emd_nm': None,
+            'ri_nm': None,
+            'full_bjd_nm': None,
+            'created_dt': None,
+            'deleted_dt': None,
+            'base_dt': '{base_dt}',
+            'msg': ''
+        },
+        'bun': None,
+        'ji': None,
+        'base_dt': '{base_dt}',
+        'msg': "Invalid 'jibun' format. Please follow the specified format."}
         ```
 
 </details><br>