Skip to content

Commit

Permalink
Fix up test docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
@e10harvey
e10harvey committed Nov 20, 2024
1 parent ec7d4cc commit 7cfdfeb
Showing 1 changed file with 47 additions and 113 deletions.
160 changes: 47 additions & 113 deletions opencsp/test/test_DocStringsExist.py
View file
Original file line number Diff line number Diff line change
@@ -1,74 +1,21 @@
import inspect
import unittest

import opencsp as opencsp
import example as example

# Assume opencsp is in PYHTONPATH
from opencsp.app.sofast.lib.ProcessSofastFringe import ProcessSofastFringe as Sofast
from opencsp.common.lib.cv import CacheableImage, SpotAnalysis
from opencsp.common.lib.cv.spot_analysis import ImagesStream, SpotAnalysisImagesStream, SpotAnalysisOperable
from opencsp.common.lib.cv.spot_analysis.image_processor import *
from opencsp.common.lib.cv.spot_analysis.image_processor import AbstractSpotAnalysisImageProcessor

# Assume opencsp is in PYHTONPATH
import opencsp as opencsp
import example as example

# TODO: why aren't these imported from import opencsp as opencsp above
from opencsp.app.camera_calibration import CameraCalibration
from opencsp.app.camera_calibration.lib.ViewAnnotatedImages import ViewAnnotatedImages
from opencsp.app.sofast.SofastGUI import SofastGUI
from opencsp.app.sofast.lib import *
from opencsp.app.select_image_points import SelectImagePoints
import opencsp.common.lib.cv.SpotAnalysis

import opencsp.app.target.target_color.target_color as target_color


class test_Docstrings(unittest.TestCase):
sofast_class_list = [
opencsp.app.sofast.lib.AbstractMeasurementSofast,
opencsp.app.sofast.lib.BlobIndex,
opencsp.app.sofast.lib.calculation_data_classes.CalculationDataGeometryFacet,
opencsp.app.sofast.lib.calculation_data_classes.CalculationDataGeometryGeneral,
opencsp.app.sofast.lib.calculation_data_classes.CalculationError,
opencsp.app.sofast.lib.calculation_data_classes.CalculationFacetEnsemble,
opencsp.app.sofast.lib.calculation_data_classes.CalculationImageProcessingFacet,
opencsp.app.sofast.lib.calculation_data_classes.CalculationImageProcessingGeneral,
opencsp.app.sofast.lib.CalibrateDisplayShape.CalibrateDisplayShape,
opencsp.app.sofast.lib.CalibrateSofastFixedDots.CalibrateSofastFixedDots,
opencsp.app.sofast.lib.CalibrateDisplayShape.DataCalculation,
opencsp.app.sofast.lib.CalibrateDisplayShape.DataInput,
opencsp.app.sofast.lib.DebugOpticsGeometry.DebugOpticsGeometry,
opencsp.app.sofast.lib.DefinitionEnsemble.DefinitionEnsemble,
opencsp.app.sofast.lib.DefinitionFacet.DefinitionFacet,
opencsp.app.sofast.lib.DisplayShape.DisplayShape,
opencsp.app.sofast.lib.DistanceOpticScreen.DistanceOpticScreen,
opencsp.app.sofast.lib.DotLocationsFixedPattern.DotLocationsFixedPattern,
opencsp.app.sofast.lib.Fringes.Fringes,
opencsp.app.sofast.lib.ImageCalibrationAbstract.ImageCalibrationAbstract,
opencsp.app.sofast.lib.ImageCalibrationGlobal.ImageCalibrationGlobal,
opencsp.app.sofast.lib.ImageCalibrationScaling.ImageCalibrationScaling,
opencsp.app.sofast.lib.MeasurementSofastFixed.MeasurementSofastFixed,
opencsp.app.sofast.lib.MeasurementSofastFringe.MeasurementSofastFringe,
opencsp.app.sofast.lib.ParamsMaskCalculation.ParamsMaskCalculation,
opencsp.app.sofast.lib.ParamsOpticGeometry.ParamsOpticGeometry,
opencsp.app.sofast.lib.ParamsSofastFixed.ParamsSofastFixed,
opencsp.app.sofast.lib.ParamsSofastFringe.ParamsSofastFringe,
opencsp.app.sofast.lib.PatternSofastFixed.PatternSofastFixed,
opencsp.app.sofast.lib.ProcessSofastFixed.ProcessSofastFixed,
opencsp.app.sofast.lib.ProcessSofastFringe.ProcessSofastFringe,
opencsp.app.sofast.lib.SofastConfiguration.SofastConfiguration,
opencsp.app.sofast.lib.SpatialOrientation.SpatialOrientation,
opencsp.app.sofast.lib.SystemSofastFixed.SystemSofastFixed,
opencsp.app.sofast.lib.SystemSofastFringe.SystemSofastFringe,
SofastGUI,
]
=======
import opencsp.app.target.target_color.target_color as target_color


def test_docstrings_exist_for_methods():
camera_calibration_class_list = [
CameraCalibration,
opencsp.app.camera_calibration.lib.calibration_camera,
Expand All @@ -82,7 +29,6 @@ def test_docstrings_exist_for_methods():

sofast_class_list = [
SofastGUI,
>>>>>>> 44978f4 (Finish testing opencsp/app for docs)
opencsp.app.sofast.lib.AbstractMeasurementSofast,
opencsp.app.sofast.lib.BlobIndex,
opencsp.app.sofast.lib.CalibrateDisplayShape.CalibrateDisplayShape,
Expand Down Expand Up @@ -140,36 +86,6 @@ def test_docstrings_exist_for_methods():
# TODO: example_sofast_fringe_list
# TODO: example_targetcolor_list

<<<<<<< HEAD
class_list = sofast_class_list + target_class_list + camera_calibration_class_list + scene_reconstruction_class_list
#class_list = [
# Sofast,
# # Spot Analysis
# SpotAnalysis,
# SpotAnalysisOperable,
# ImagesStream,
# SpotAnalysisImagesStream,
# CacheableImage,
# AbstractAggregateImageProcessor,
# AbstractSpotAnalysisImageProcessor,
# AbstractVisualizationImageProcessor,
# AnnotationImageProcessor,
# AverageByGroupImageProcessor,
# BcsLocatorImageProcessor,
# ConvolutionImageProcessor,
# CroppingImageProcessor,
# EchoImageProcessor,
# ExposureDetectionImageProcessor,
# FalseColorImageProcessor,
# HotspotImageProcessor,
# LogScaleImageProcessor,
# NullImageSubtractionImageProcessor,
# PopulationStatisticsImageProcessor,
# SupportingImagesCollectorImageProcessor,
# View3dImageProcessor,
# ViewCrossSectionImageProcessor,
# TODO: List all user-facing classes here.
=======
app_class_list = (
camera_calibration_class_list
+ scene_reconstruction_class_list
Expand All @@ -178,33 +94,51 @@ def test_docstrings_exist_for_methods():
+ target_class_list
)

cv_class_list = [
opencsp.common.lib.cv.CacheableImage,
opencsp.common.lib.cv.SpotAnalysis,
opencsp.common.lib.cv.spot_analysis.ImagesStream,
opencsp.common.lib.cv.spot_analysis.SpotAnalysisImagesStream,
opencsp.common.lib.cv.spot_analysis.SpotAnalysisOperable,
opencsp.common.lib.cv.spot_analysis.image_processor.AbstractAggregateImageProcessor,
opencsp.common.lib.cv.spot_analysis.image_processor.AbstractSpotAnalysisImageProcessor,
opencsp.common.lib.cv.spot_analysis.image_processor.AbstractVisualizationImageProcessor,
opencsp.common.lib.cv.spot_analysis.image_processor.AnnotationImageProcessor,
opencsp.common.lib.cv.spot_analysis.image_processor.AverageByGroupImageProcessor,
opencsp.common.lib.cv.spot_analysis.image_processor.BcsLocatorImageProcessor,
opencsp.common.lib.cv.spot_analysis.image_processor.ConvolutionImageProcessor,
opencsp.common.lib.cv.spot_analysis.image_processor.CroppingImageProcessor,
opencsp.common.lib.cv.spot_analysis.image_processor.EchoImageProcessor,
opencsp.common.lib.cv.spot_analysis.image_processor.ExposureDetectionImageProcessor,
opencsp.common.lib.cv.spot_analysis.image_processor.FalseColorImageProcessor,
opencsp.common.lib.cv.spot_analysis.image_processor.HotspotImageProcessor,
opencsp.common.lib.cv.spot_analysis.image_processor.LogScaleImageProcessor,
opencsp.common.lib.cv.spot_analysis.image_processor.NullImageSubtractionImageProcessor,
opencsp.common.lib.cv.spot_analysis.image_processor.PopulationStatisticsImageProcessor,
opencsp.common.lib.cv.spot_analysis.image_processor.SupportingImagesCollectorImageProcessor,
opencsp.common.lib.cv.spot_analysis.image_processor.View3dImageProcessor,
opencsp.common.lib.cv.spot_analysis.image_processor.ViewCrossSectionImageProcessor,
]

class_list = app_class_list
>>>>>>> 44978f4 (Finish testing opencsp/app for docs)

<<<<<<< HEAD
def test_docstrings_exist_for_methods(self):
for class_module in self.class_list:
=======
for class_module in class_list:
print(class_module)
method_list = []
if inspect.isclass(class_module):
method_list = [
func
for func in class_module.__dict__
if callable(getattr(class_module, func))
and not func.startswith("__")
and not func.startswith("_")
and not hasattr(super(class_module), func)
]
else:
>>>>>>> 767739b (Check opencsp.app for doc strings)
method_list = [
func
for func in dir(class_module)
if callable(getattr(class_module, func)) and not func.startswith("__") and not func.startswith("_")
]

if inspect.isclass(class_module):
method_list = [
func
for func in class_module.__dict__
if callable(getattr(class_module, func))
and not func.startswith("__")
and not func.startswith("_")
and not hasattr(super(class_module), func)
]
else:
method_list = [
func
for func in dir(class_module)
if callable(getattr(class_module, func)) and not func.startswith("__") and not func.startswith("_")
]
undocumented_methods: list[str] = []

for method in method_list:
Expand All @@ -217,11 +151,11 @@ def test_docstrings_exist_for_methods(self):
if not doc_exists:
undocumented_methods.append(method)

self.assertEqual(
len(undocumented_methods),
0,
f"Found undocumented methods in {class_module}:\n\t" + "\n\t".join(undocumented_methods),
)
if len((undocumented_methods)) != 0:
print(f"Found undocumented methods in {class_module}:")
for name in undocumented_methods:
print(f"\t{name}")
assert len((undocumented_methods)) == 0


if __name__ == '__main__':
Expand Down

0 comments on commit 7cfdfeb

Please sign in to comment.