An Empirical Study of API Misuses of Data-Centric Libraries

1. 연구 배경 및 문제 정의 (Problem)

• 배경: 소프트웨어 개발자는 기능 구현을 위해 서드파티 라이브러리의 API 를 광범위하게 사용합니다. 그러나 이러한 라이브러리는 특정 가정과 사용 제약 조건을 내포하고 있으며, 이를 위반할 경우 API 오용 (API Misuse) 이 발생합니다.
• 기존 연구의 한계: API 오용은 오랫동안 연구되어 왔으나, 주로 Java 와 같은 전통적인 라이브러리의 제어 흐름 (Control Flow) 및 데이터 흐름 (Data Flow) 위반에 초점을 맞추었습니다. 최근 Wei et al. (2024) 은 딥러닝 라이브러리 (TensorFlow, PyTorch) 의 오용을 연구하며, 데이터 형태 불일치나 장치 (Device) 관리 오류 등 기존과 다른 특성을 발견했습니다.
• 문제 제기: 저자들은 딥러닝 라이브러리에서 관찰된 이러한 오용 특성들이 딥러닝 고유의 문제라기보다는 **'데이터 중심 (Data-Centric)'**인 API 의 본질적 특성에서 기인할 것이라고 추측합니다. 데이터 처리, 수치 계산, 머신러닝, 시각화 등 다양한 분야에서 데이터를 다루는 라이브러리들은 복잡한 데이터 구조, 정교한 처리 워크플로우, 그리고 수많은 매개변수를 요구하므로, 전통적인 라이브러리보다 올바르게 사용하기가 더 어려울 수 있습니다.
• 연구 목표: 딥러닝 라이브러리를 넘어, 일반적인 데이터 중심 라이브러리 (NumPy, pandas, scikit-learn, Matplotlib, seaborn) 에서 발생하는 API 오용의 유형, 원인, 증상 및 문서화 상태를 실증적으로 분석하는 것입니다.

2. 연구 방법론 (Methodology)

• 연구 대상: 파이썬 기반의 5 가지 주요 데이터 중심 라이브러리: NumPy, pandas, scikit-learn, Matplotlib, seaborn.
• 데이터 수집:
  1. Stack Overflow (SO): 2019~2023 년에 게시된 질문 중 해당 라이브러리 태그가 붙은 것들을 필터링 (답변 유무, 점수, 코드 포함 여부 등) 하여 345 개의 포스트를 수동 분석.
  2. GitHub (GH): 5 개 라이브러리를 의존성으로 사용하는 오픈소스 프로젝트의 커밋 이력을 분석. API 사용 변경이 포함된 358 개의 커밋을 수동 검토하여 오용 수정 (Fix) 사례를 식별.
• 분석 프로세스:
  • 식별된 오용 사례를 재현 가능한 예제 (Reproducible Example) 로 만들어 오용의 증상과 원인을 확인.
  • Wei et al. 의 딥러닝 오용 분류 체계 (Taxonomy) 를 기반으로 오용 유형, 근본 원인 (Root Cause), 증상 (Symptom) 을 분류.
  • 새로운 차원 추가: 기존 분류 체계에 '데이터 의존성 (Data Dependency)' 차원을 추가 (데이터의 종류나 값에 따라 같은 API 사용이 오용이 될 수도 있고 정상일 수도 있는 경우).
  • 문서화 확인: 해당 오용과 관련된 API 사용 지침이 라이브러리 공식 문서에 명시되어 있는지 조사.

3. 주요 기여 (Key Contributions)

1. 데이터 중심 라이브러리의 정의 및 오용 특성 규명: 딥러닝 라이브러리의 오용 특성이 데이터 중심 라이브러리 전반에 걸쳐 공통적으로 나타남을 증명.
2. 실증 데이터셋 구축: 5 개 라이브러리에서 수집된 49 개의 API 오용 사례 (45 개 고유 API) 를 구축하고, 각 사례에 대한 재현 가능한 예제를 제공.
3. 분류 체계 확장: 기존 딥러닝 오용 분류 체계에 '데이터 의존성 (Data Dependency)' 개념을 도입하여 데이터의 맥락에 따라 오용 여부가 결정되는 현상을 포착.
4. 문서화 상태 분석: 오용된 API 에 대해 공식 문서에 사용 지침이 명시되어 있었음에도 불구하고 개발자가 오용을 저지른 사례를 발견하고 그 비율을 제시.

4. 주요 결과 (Key Results)

4.1 오용 유형 (Misuse Types)

• 가장 흔한 오용: API 매개변수 (Parameter) 관련 오용이 전체의 **51%**를 차지 (가장 많음). 그다음으로 API 메서드 (43%), API 조건 (6%) 순.
• 데이터 의존성: 전체 오용의 **55%**가 데이터 의존적임. 즉, 입력된 데이터의 타입이나 값에 따라 API 사용이 잘못될 수 있음.
• 구체적 유형:
  • API 매개변수 교체 (31%): 잘못된 값이나 포맷 전달 (예: 날짜 포맷 오류, 지원되지 않는 스타일 값).
  • API 매개변수 누락 (18%): 필수적이거나 문맥상 필요한 파라미터 생략 (예: inplace=False일 때 할당 연산 누락).
  • 중복 호출 (12%): 내부적으로 이미 호출되는 메서드를 중복 호출하여 오류 발생.
  • 호출 순서 위반 (4%): 특정 순서로 API 를 호출해야 함을 무시.

4.2 근본 원인 (Root Causes)

• 데이터 변환 오류 (39%): 가장 큰 원인. 데이터 타입, 형태 (Shape), 포맷 변환 실패 (예: 1D 배열 기대 시 2D 전달).
• 구성 오류 (Configuration Errors, 24%): 기존 분류에 없던 새로운 카테고리. API 내부에서 기대하는 설정 값 누락 또는 오류 (예: 시각화 라이브러리에서 색상 팔레트 설정 실패).
• 알고리즘 오류 (20%): 수학적 오류 또는 잘못된 알고리즘 적용 (예: 이진 분류 전용 API 를 다중 클래스에 적용).
• 널 참조 오류 (10%), 장치 관리 오류 (2%): 딥러닝 라이브러리에서 흔했던 장치 (CPU/GPU) 관리 오류는 데이터 중심 라이브러리에서는 드묾.

4.3 증상 (Symptoms)

• 프로그램 충돌 (41%): 가장 흔한 증상.
• 예상치 못한 출력 (35%): 런타임 에러 없이 **침묵 (Silently)**하게 잘못된 결과를 생성. 이는 디버깅이 매우 어렵고 프로그램 전체로 오류가 전파될 위험이 큼.
• 낮은 효율성 (20%), 경고 (2%): 딥러닝 연구에서 흔했던 성능 저하나 경고는 상대적으로 적게 관찰됨.

4.4 문서화 현황

• **39%**의 오용 사례는 공식 문서에 올바른 사용 지침이 명시되어 있었음.
• 이는 개발자가 문서를 읽었음에도 불구하고, **데이터의 맥락 (Data Context)**을 이해하지 못하거나 문서의 숨겨진 가정을 파악하지 못해 오용을 저질렀음을 시사.

5. 연구의 의의 및 시사점 (Significance)

• 언어 및 API 설계:
  • 데이터의 내용과 포맷에 대한 가정을 API 설계자가 강제할 수 있는 언어적 메커니즘이 부족함.
  • 기존 타입 시스템 (Type Hints) 은 데이터 구조의 내용 (Content) 을 검증하지 못하므로, 데이터 의존성 오용을 방지하기 위한 새로운 언어 지원 도구 필요.
• API 문서화:
  • 문서에 명시된 지침이 있어도 개발자가 오용을 저지르는 경우가 많음. 이는 문서의 정보가 개발자에게 효과적으로 전달되지 않음을 의미.
  • 문서에서 중요한 제약 조건 (특히 데이터 관련) 을 더 명확하게 표출하거나, 자동화 도구를 통해 문서 정보를 추출하는 연구 필요.
• 오용 탐지 도구 (Misuse Detectors):
  • 기존 도구들은 주로 코드 패턴이나 정적 분석에 의존하지만, 데이터 중심 라이브러리의 오용은 데이터의 내용과 API 호출 간의 관계를 분석해야 탐지 가능.
  • 동적 분석과 데이터 포맷/내용을 고려한 새로운 탐지 기술 개발 필요.

결론

이 연구는 딥러닝 라이브러리에서 발견된 API 오용의 특성이 데이터 중심 라이브러리 전반에 걸쳐 공통적으로 나타난다는 것을 실증적으로 증명했습니다. 특히 **데이터 의존성 (Data Dependency)**과 매개변수 오용이 주요 원인이었으며, 문서를 읽었음에도 오용이 발생한다는 점은 API 설계와 문서화, 그리고 오용 탐지 도구 개발에 있어 데이터의 맥락을 고려한 새로운 접근이 필요함을 강조합니다.