oscura 0.0.1__py3-none-any.whl → 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- oscura/__init__.py +813 -8
- oscura/__main__.py +392 -0
- oscura/analyzers/__init__.py +37 -0
- oscura/analyzers/digital/__init__.py +177 -0
- oscura/analyzers/digital/bus.py +691 -0
- oscura/analyzers/digital/clock.py +805 -0
- oscura/analyzers/digital/correlation.py +720 -0
- oscura/analyzers/digital/edges.py +632 -0
- oscura/analyzers/digital/extraction.py +413 -0
- oscura/analyzers/digital/quality.py +878 -0
- oscura/analyzers/digital/signal_quality.py +877 -0
- oscura/analyzers/digital/thresholds.py +708 -0
- oscura/analyzers/digital/timing.py +1104 -0
- oscura/analyzers/eye/__init__.py +46 -0
- oscura/analyzers/eye/diagram.py +434 -0
- oscura/analyzers/eye/metrics.py +555 -0
- oscura/analyzers/jitter/__init__.py +83 -0
- oscura/analyzers/jitter/ber.py +333 -0
- oscura/analyzers/jitter/decomposition.py +759 -0
- oscura/analyzers/jitter/measurements.py +413 -0
- oscura/analyzers/jitter/spectrum.py +220 -0
- oscura/analyzers/measurements.py +40 -0
- oscura/analyzers/packet/__init__.py +171 -0
- oscura/analyzers/packet/daq.py +1077 -0
- oscura/analyzers/packet/metrics.py +437 -0
- oscura/analyzers/packet/parser.py +327 -0
- oscura/analyzers/packet/payload.py +2156 -0
- oscura/analyzers/packet/payload_analysis.py +1312 -0
- oscura/analyzers/packet/payload_extraction.py +236 -0
- oscura/analyzers/packet/payload_patterns.py +670 -0
- oscura/analyzers/packet/stream.py +359 -0
- oscura/analyzers/patterns/__init__.py +266 -0
- oscura/analyzers/patterns/clustering.py +1036 -0
- oscura/analyzers/patterns/discovery.py +539 -0
- oscura/analyzers/patterns/learning.py +797 -0
- oscura/analyzers/patterns/matching.py +1091 -0
- oscura/analyzers/patterns/periodic.py +650 -0
- oscura/analyzers/patterns/sequences.py +767 -0
- oscura/analyzers/power/__init__.py +116 -0
- oscura/analyzers/power/ac_power.py +391 -0
- oscura/analyzers/power/basic.py +383 -0
- oscura/analyzers/power/conduction.py +314 -0
- oscura/analyzers/power/efficiency.py +297 -0
- oscura/analyzers/power/ripple.py +356 -0
- oscura/analyzers/power/soa.py +372 -0
- oscura/analyzers/power/switching.py +479 -0
- oscura/analyzers/protocol/__init__.py +150 -0
- oscura/analyzers/protocols/__init__.py +150 -0
- oscura/analyzers/protocols/base.py +500 -0
- oscura/analyzers/protocols/can.py +620 -0
- oscura/analyzers/protocols/can_fd.py +448 -0
- oscura/analyzers/protocols/flexray.py +405 -0
- oscura/analyzers/protocols/hdlc.py +399 -0
- oscura/analyzers/protocols/i2c.py +368 -0
- oscura/analyzers/protocols/i2s.py +296 -0
- oscura/analyzers/protocols/jtag.py +393 -0
- oscura/analyzers/protocols/lin.py +445 -0
- oscura/analyzers/protocols/manchester.py +333 -0
- oscura/analyzers/protocols/onewire.py +501 -0
- oscura/analyzers/protocols/spi.py +334 -0
- oscura/analyzers/protocols/swd.py +325 -0
- oscura/analyzers/protocols/uart.py +393 -0
- oscura/analyzers/protocols/usb.py +495 -0
- oscura/analyzers/signal_integrity/__init__.py +63 -0
- oscura/analyzers/signal_integrity/embedding.py +294 -0
- oscura/analyzers/signal_integrity/equalization.py +370 -0
- oscura/analyzers/signal_integrity/sparams.py +484 -0
- oscura/analyzers/spectral/__init__.py +53 -0
- oscura/analyzers/spectral/chunked.py +273 -0
- oscura/analyzers/spectral/chunked_fft.py +571 -0
- oscura/analyzers/spectral/chunked_wavelet.py +391 -0
- oscura/analyzers/spectral/fft.py +92 -0
- oscura/analyzers/statistical/__init__.py +250 -0
- oscura/analyzers/statistical/checksum.py +923 -0
- oscura/analyzers/statistical/chunked_corr.py +228 -0
- oscura/analyzers/statistical/classification.py +778 -0
- oscura/analyzers/statistical/entropy.py +1113 -0
- oscura/analyzers/statistical/ngrams.py +614 -0
- oscura/analyzers/statistics/__init__.py +119 -0
- oscura/analyzers/statistics/advanced.py +885 -0
- oscura/analyzers/statistics/basic.py +263 -0
- oscura/analyzers/statistics/correlation.py +630 -0
- oscura/analyzers/statistics/distribution.py +298 -0
- oscura/analyzers/statistics/outliers.py +463 -0
- oscura/analyzers/statistics/streaming.py +93 -0
- oscura/analyzers/statistics/trend.py +520 -0
- oscura/analyzers/validation.py +598 -0
- oscura/analyzers/waveform/__init__.py +36 -0
- oscura/analyzers/waveform/measurements.py +943 -0
- oscura/analyzers/waveform/measurements_with_uncertainty.py +371 -0
- oscura/analyzers/waveform/spectral.py +1689 -0
- oscura/analyzers/waveform/wavelets.py +298 -0
- oscura/api/__init__.py +62 -0
- oscura/api/dsl.py +538 -0
- oscura/api/fluent.py +571 -0
- oscura/api/operators.py +498 -0
- oscura/api/optimization.py +392 -0
- oscura/api/profiling.py +396 -0
- oscura/automotive/__init__.py +73 -0
- oscura/automotive/can/__init__.py +52 -0
- oscura/automotive/can/analysis.py +356 -0
- oscura/automotive/can/checksum.py +250 -0
- oscura/automotive/can/correlation.py +212 -0
- oscura/automotive/can/discovery.py +355 -0
- oscura/automotive/can/message_wrapper.py +375 -0
- oscura/automotive/can/models.py +385 -0
- oscura/automotive/can/patterns.py +381 -0
- oscura/automotive/can/session.py +452 -0
- oscura/automotive/can/state_machine.py +300 -0
- oscura/automotive/can/stimulus_response.py +461 -0
- oscura/automotive/dbc/__init__.py +15 -0
- oscura/automotive/dbc/generator.py +156 -0
- oscura/automotive/dbc/parser.py +146 -0
- oscura/automotive/dtc/__init__.py +30 -0
- oscura/automotive/dtc/database.py +3036 -0
- oscura/automotive/j1939/__init__.py +14 -0
- oscura/automotive/j1939/decoder.py +745 -0
- oscura/automotive/loaders/__init__.py +35 -0
- oscura/automotive/loaders/asc.py +98 -0
- oscura/automotive/loaders/blf.py +77 -0
- oscura/automotive/loaders/csv_can.py +136 -0
- oscura/automotive/loaders/dispatcher.py +136 -0
- oscura/automotive/loaders/mdf.py +331 -0
- oscura/automotive/loaders/pcap.py +132 -0
- oscura/automotive/obd/__init__.py +14 -0
- oscura/automotive/obd/decoder.py +707 -0
- oscura/automotive/uds/__init__.py +48 -0
- oscura/automotive/uds/decoder.py +265 -0
- oscura/automotive/uds/models.py +64 -0
- oscura/automotive/visualization.py +369 -0
- oscura/batch/__init__.py +55 -0
- oscura/batch/advanced.py +627 -0
- oscura/batch/aggregate.py +300 -0
- oscura/batch/analyze.py +139 -0
- oscura/batch/logging.py +487 -0
- oscura/batch/metrics.py +556 -0
- oscura/builders/__init__.py +41 -0
- oscura/builders/signal_builder.py +1131 -0
- oscura/cli/__init__.py +14 -0
- oscura/cli/batch.py +339 -0
- oscura/cli/characterize.py +273 -0
- oscura/cli/compare.py +775 -0
- oscura/cli/decode.py +551 -0
- oscura/cli/main.py +247 -0
- oscura/cli/shell.py +350 -0
- oscura/comparison/__init__.py +66 -0
- oscura/comparison/compare.py +397 -0
- oscura/comparison/golden.py +487 -0
- oscura/comparison/limits.py +391 -0
- oscura/comparison/mask.py +434 -0
- oscura/comparison/trace_diff.py +30 -0
- oscura/comparison/visualization.py +481 -0
- oscura/compliance/__init__.py +70 -0
- oscura/compliance/advanced.py +756 -0
- oscura/compliance/masks.py +363 -0
- oscura/compliance/reporting.py +483 -0
- oscura/compliance/testing.py +298 -0
- oscura/component/__init__.py +38 -0
- oscura/component/impedance.py +365 -0
- oscura/component/reactive.py +598 -0
- oscura/component/transmission_line.py +312 -0
- oscura/config/__init__.py +191 -0
- oscura/config/defaults.py +254 -0
- oscura/config/loader.py +348 -0
- oscura/config/memory.py +271 -0
- oscura/config/migration.py +458 -0
- oscura/config/pipeline.py +1077 -0
- oscura/config/preferences.py +530 -0
- oscura/config/protocol.py +875 -0
- oscura/config/schema.py +713 -0
- oscura/config/settings.py +420 -0
- oscura/config/thresholds.py +599 -0
- oscura/convenience.py +457 -0
- oscura/core/__init__.py +299 -0
- oscura/core/audit.py +457 -0
- oscura/core/backend_selector.py +405 -0
- oscura/core/cache.py +590 -0
- oscura/core/cancellation.py +439 -0
- oscura/core/confidence.py +225 -0
- oscura/core/config.py +506 -0
- oscura/core/correlation.py +216 -0
- oscura/core/cross_domain.py +422 -0
- oscura/core/debug.py +301 -0
- oscura/core/edge_cases.py +541 -0
- oscura/core/exceptions.py +535 -0
- oscura/core/gpu_backend.py +523 -0
- oscura/core/lazy.py +832 -0
- oscura/core/log_query.py +540 -0
- oscura/core/logging.py +931 -0
- oscura/core/logging_advanced.py +952 -0
- oscura/core/memoize.py +171 -0
- oscura/core/memory_check.py +274 -0
- oscura/core/memory_guard.py +290 -0
- oscura/core/memory_limits.py +336 -0
- oscura/core/memory_monitor.py +453 -0
- oscura/core/memory_progress.py +465 -0
- oscura/core/memory_warnings.py +315 -0
- oscura/core/numba_backend.py +362 -0
- oscura/core/performance.py +352 -0
- oscura/core/progress.py +524 -0
- oscura/core/provenance.py +358 -0
- oscura/core/results.py +331 -0
- oscura/core/types.py +504 -0
- oscura/core/uncertainty.py +383 -0
- oscura/discovery/__init__.py +52 -0
- oscura/discovery/anomaly_detector.py +672 -0
- oscura/discovery/auto_decoder.py +415 -0
- oscura/discovery/comparison.py +497 -0
- oscura/discovery/quality_validator.py +528 -0
- oscura/discovery/signal_detector.py +769 -0
- oscura/dsl/__init__.py +73 -0
- oscura/dsl/commands.py +246 -0
- oscura/dsl/interpreter.py +455 -0
- oscura/dsl/parser.py +689 -0
- oscura/dsl/repl.py +172 -0
- oscura/exceptions.py +59 -0
- oscura/exploratory/__init__.py +111 -0
- oscura/exploratory/error_recovery.py +642 -0
- oscura/exploratory/fuzzy.py +513 -0
- oscura/exploratory/fuzzy_advanced.py +786 -0
- oscura/exploratory/legacy.py +831 -0
- oscura/exploratory/parse.py +358 -0
- oscura/exploratory/recovery.py +275 -0
- oscura/exploratory/sync.py +382 -0
- oscura/exploratory/unknown.py +707 -0
- oscura/export/__init__.py +25 -0
- oscura/export/wireshark/README.md +265 -0
- oscura/export/wireshark/__init__.py +47 -0
- oscura/export/wireshark/generator.py +312 -0
- oscura/export/wireshark/lua_builder.py +159 -0
- oscura/export/wireshark/templates/dissector.lua.j2 +92 -0
- oscura/export/wireshark/type_mapping.py +165 -0
- oscura/export/wireshark/validator.py +105 -0
- oscura/exporters/__init__.py +94 -0
- oscura/exporters/csv.py +303 -0
- oscura/exporters/exporters.py +44 -0
- oscura/exporters/hdf5.py +219 -0
- oscura/exporters/html_export.py +701 -0
- oscura/exporters/json_export.py +291 -0
- oscura/exporters/markdown_export.py +367 -0
- oscura/exporters/matlab_export.py +354 -0
- oscura/exporters/npz_export.py +219 -0
- oscura/exporters/spice_export.py +210 -0
- oscura/extensibility/__init__.py +131 -0
- oscura/extensibility/docs.py +752 -0
- oscura/extensibility/extensions.py +1125 -0
- oscura/extensibility/logging.py +259 -0
- oscura/extensibility/measurements.py +485 -0
- oscura/extensibility/plugins.py +414 -0
- oscura/extensibility/registry.py +346 -0
- oscura/extensibility/templates.py +913 -0
- oscura/extensibility/validation.py +651 -0
- oscura/filtering/__init__.py +89 -0
- oscura/filtering/base.py +563 -0
- oscura/filtering/convenience.py +564 -0
- oscura/filtering/design.py +725 -0
- oscura/filtering/filters.py +32 -0
- oscura/filtering/introspection.py +605 -0
- oscura/guidance/__init__.py +24 -0
- oscura/guidance/recommender.py +429 -0
- oscura/guidance/wizard.py +518 -0
- oscura/inference/__init__.py +251 -0
- oscura/inference/active_learning/README.md +153 -0
- oscura/inference/active_learning/__init__.py +38 -0
- oscura/inference/active_learning/lstar.py +257 -0
- oscura/inference/active_learning/observation_table.py +230 -0
- oscura/inference/active_learning/oracle.py +78 -0
- oscura/inference/active_learning/teachers/__init__.py +15 -0
- oscura/inference/active_learning/teachers/simulator.py +192 -0
- oscura/inference/adaptive_tuning.py +453 -0
- oscura/inference/alignment.py +653 -0
- oscura/inference/bayesian.py +943 -0
- oscura/inference/binary.py +1016 -0
- oscura/inference/crc_reverse.py +711 -0
- oscura/inference/logic.py +288 -0
- oscura/inference/message_format.py +1305 -0
- oscura/inference/protocol.py +417 -0
- oscura/inference/protocol_dsl.py +1084 -0
- oscura/inference/protocol_library.py +1230 -0
- oscura/inference/sequences.py +809 -0
- oscura/inference/signal_intelligence.py +1509 -0
- oscura/inference/spectral.py +215 -0
- oscura/inference/state_machine.py +634 -0
- oscura/inference/stream.py +918 -0
- oscura/integrations/__init__.py +59 -0
- oscura/integrations/llm.py +1827 -0
- oscura/jupyter/__init__.py +32 -0
- oscura/jupyter/display.py +268 -0
- oscura/jupyter/magic.py +334 -0
- oscura/loaders/__init__.py +526 -0
- oscura/loaders/binary.py +69 -0
- oscura/loaders/configurable.py +1255 -0
- oscura/loaders/csv.py +26 -0
- oscura/loaders/csv_loader.py +473 -0
- oscura/loaders/hdf5.py +9 -0
- oscura/loaders/hdf5_loader.py +510 -0
- oscura/loaders/lazy.py +370 -0
- oscura/loaders/mmap_loader.py +583 -0
- oscura/loaders/numpy_loader.py +436 -0
- oscura/loaders/pcap.py +432 -0
- oscura/loaders/preprocessing.py +368 -0
- oscura/loaders/rigol.py +287 -0
- oscura/loaders/sigrok.py +321 -0
- oscura/loaders/tdms.py +367 -0
- oscura/loaders/tektronix.py +711 -0
- oscura/loaders/validation.py +584 -0
- oscura/loaders/vcd.py +464 -0
- oscura/loaders/wav.py +233 -0
- oscura/math/__init__.py +45 -0
- oscura/math/arithmetic.py +824 -0
- oscura/math/interpolation.py +413 -0
- oscura/onboarding/__init__.py +39 -0
- oscura/onboarding/help.py +498 -0
- oscura/onboarding/tutorials.py +405 -0
- oscura/onboarding/wizard.py +466 -0
- oscura/optimization/__init__.py +19 -0
- oscura/optimization/parallel.py +440 -0
- oscura/optimization/search.py +532 -0
- oscura/pipeline/__init__.py +43 -0
- oscura/pipeline/base.py +338 -0
- oscura/pipeline/composition.py +242 -0
- oscura/pipeline/parallel.py +448 -0
- oscura/pipeline/pipeline.py +375 -0
- oscura/pipeline/reverse_engineering.py +1119 -0
- oscura/plugins/__init__.py +122 -0
- oscura/plugins/base.py +272 -0
- oscura/plugins/cli.py +497 -0
- oscura/plugins/discovery.py +411 -0
- oscura/plugins/isolation.py +418 -0
- oscura/plugins/lifecycle.py +959 -0
- oscura/plugins/manager.py +493 -0
- oscura/plugins/registry.py +421 -0
- oscura/plugins/versioning.py +372 -0
- oscura/py.typed +0 -0
- oscura/quality/__init__.py +65 -0
- oscura/quality/ensemble.py +740 -0
- oscura/quality/explainer.py +338 -0
- oscura/quality/scoring.py +616 -0
- oscura/quality/warnings.py +456 -0
- oscura/reporting/__init__.py +248 -0
- oscura/reporting/advanced.py +1234 -0
- oscura/reporting/analyze.py +448 -0
- oscura/reporting/argument_preparer.py +596 -0
- oscura/reporting/auto_report.py +507 -0
- oscura/reporting/batch.py +615 -0
- oscura/reporting/chart_selection.py +223 -0
- oscura/reporting/comparison.py +330 -0
- oscura/reporting/config.py +615 -0
- oscura/reporting/content/__init__.py +39 -0
- oscura/reporting/content/executive.py +127 -0
- oscura/reporting/content/filtering.py +191 -0
- oscura/reporting/content/minimal.py +257 -0
- oscura/reporting/content/verbosity.py +162 -0
- oscura/reporting/core.py +508 -0
- oscura/reporting/core_formats/__init__.py +17 -0
- oscura/reporting/core_formats/multi_format.py +210 -0
- oscura/reporting/engine.py +836 -0
- oscura/reporting/export.py +366 -0
- oscura/reporting/formatting/__init__.py +129 -0
- oscura/reporting/formatting/emphasis.py +81 -0
- oscura/reporting/formatting/numbers.py +403 -0
- oscura/reporting/formatting/standards.py +55 -0
- oscura/reporting/formatting.py +466 -0
- oscura/reporting/html.py +578 -0
- oscura/reporting/index.py +590 -0
- oscura/reporting/multichannel.py +296 -0
- oscura/reporting/output.py +379 -0
- oscura/reporting/pdf.py +373 -0
- oscura/reporting/plots.py +731 -0
- oscura/reporting/pptx_export.py +360 -0
- oscura/reporting/renderers/__init__.py +11 -0
- oscura/reporting/renderers/pdf.py +94 -0
- oscura/reporting/sections.py +471 -0
- oscura/reporting/standards.py +680 -0
- oscura/reporting/summary_generator.py +368 -0
- oscura/reporting/tables.py +397 -0
- oscura/reporting/template_system.py +724 -0
- oscura/reporting/templates/__init__.py +15 -0
- oscura/reporting/templates/definition.py +205 -0
- oscura/reporting/templates/index.html +649 -0
- oscura/reporting/templates/index.md +173 -0
- oscura/schemas/__init__.py +158 -0
- oscura/schemas/bus_configuration.json +322 -0
- oscura/schemas/device_mapping.json +182 -0
- oscura/schemas/packet_format.json +418 -0
- oscura/schemas/protocol_definition.json +363 -0
- oscura/search/__init__.py +16 -0
- oscura/search/anomaly.py +292 -0
- oscura/search/context.py +149 -0
- oscura/search/pattern.py +160 -0
- oscura/session/__init__.py +34 -0
- oscura/session/annotations.py +289 -0
- oscura/session/history.py +313 -0
- oscura/session/session.py +445 -0
- oscura/streaming/__init__.py +43 -0
- oscura/streaming/chunked.py +611 -0
- oscura/streaming/progressive.py +393 -0
- oscura/streaming/realtime.py +622 -0
- oscura/testing/__init__.py +54 -0
- oscura/testing/synthetic.py +808 -0
- oscura/triggering/__init__.py +68 -0
- oscura/triggering/base.py +229 -0
- oscura/triggering/edge.py +353 -0
- oscura/triggering/pattern.py +344 -0
- oscura/triggering/pulse.py +581 -0
- oscura/triggering/window.py +453 -0
- oscura/ui/__init__.py +48 -0
- oscura/ui/formatters.py +526 -0
- oscura/ui/progressive_display.py +340 -0
- oscura/utils/__init__.py +99 -0
- oscura/utils/autodetect.py +338 -0
- oscura/utils/buffer.py +389 -0
- oscura/utils/lazy.py +407 -0
- oscura/utils/lazy_imports.py +147 -0
- oscura/utils/memory.py +836 -0
- oscura/utils/memory_advanced.py +1326 -0
- oscura/utils/memory_extensions.py +465 -0
- oscura/utils/progressive.py +352 -0
- oscura/utils/windowing.py +362 -0
- oscura/visualization/__init__.py +321 -0
- oscura/visualization/accessibility.py +526 -0
- oscura/visualization/annotations.py +374 -0
- oscura/visualization/axis_scaling.py +305 -0
- oscura/visualization/colors.py +453 -0
- oscura/visualization/digital.py +337 -0
- oscura/visualization/eye.py +420 -0
- oscura/visualization/histogram.py +281 -0
- oscura/visualization/interactive.py +858 -0
- oscura/visualization/jitter.py +702 -0
- oscura/visualization/keyboard.py +394 -0
- oscura/visualization/layout.py +365 -0
- oscura/visualization/optimization.py +1028 -0
- oscura/visualization/palettes.py +446 -0
- oscura/visualization/plot.py +92 -0
- oscura/visualization/power.py +290 -0
- oscura/visualization/power_extended.py +626 -0
- oscura/visualization/presets.py +467 -0
- oscura/visualization/protocols.py +932 -0
- oscura/visualization/render.py +207 -0
- oscura/visualization/rendering.py +444 -0
- oscura/visualization/reverse_engineering.py +791 -0
- oscura/visualization/signal_integrity.py +808 -0
- oscura/visualization/specialized.py +553 -0
- oscura/visualization/spectral.py +811 -0
- oscura/visualization/styles.py +381 -0
- oscura/visualization/thumbnails.py +311 -0
- oscura/visualization/time_axis.py +351 -0
- oscura/visualization/waveform.py +367 -0
- oscura/workflow/__init__.py +13 -0
- oscura/workflow/dag.py +377 -0
- oscura/workflows/__init__.py +58 -0
- oscura/workflows/compliance.py +280 -0
- oscura/workflows/digital.py +272 -0
- oscura/workflows/multi_trace.py +502 -0
- oscura/workflows/power.py +178 -0
- oscura/workflows/protocol.py +492 -0
- oscura/workflows/reverse_engineering.py +639 -0
- oscura/workflows/signal_integrity.py +227 -0
- oscura-0.1.0.dist-info/METADATA +300 -0
- oscura-0.1.0.dist-info/RECORD +463 -0
- oscura-0.1.0.dist-info/entry_points.txt +2 -0
- {oscura-0.0.1.dist-info → oscura-0.1.0.dist-info}/licenses/LICENSE +1 -1
- oscura-0.0.1.dist-info/METADATA +0 -63
- oscura-0.0.1.dist-info/RECORD +0 -5
- {oscura-0.0.1.dist-info → oscura-0.1.0.dist-info}/WHEEL +0 -0
oscura/reporting/html.py
ADDED
|
@@ -0,0 +1,578 @@
|
|
|
1
|
+
"""HTML report generation for TraceKit.
|
|
2
|
+
|
|
3
|
+
This module provides professional HTML report generation with modern features
|
|
4
|
+
including responsive design, interactive plots, and collapsible sections.
|
|
5
|
+
|
|
6
|
+
Features:
|
|
7
|
+
- Professional formatting standards
|
|
8
|
+
- Visual emphasis system
|
|
9
|
+
- Smart content filtering (interactive)
|
|
10
|
+
- Modern HTML with progressive disclosure
|
|
11
|
+
- Collapsible sections mechanism
|
|
12
|
+
|
|
13
|
+
Example:
|
|
14
|
+
>>> from oscura.reporting.html import generate_html_report
|
|
15
|
+
>>> html = generate_html_report(report, interactive=True, dark_mode=False)
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
from __future__ import annotations
|
|
19
|
+
|
|
20
|
+
from pathlib import Path
|
|
21
|
+
from typing import TYPE_CHECKING, Any
|
|
22
|
+
|
|
23
|
+
if TYPE_CHECKING:
|
|
24
|
+
from oscura.reporting.core import Report
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
def generate_html_report(
|
|
28
|
+
report: Report,
|
|
29
|
+
*,
|
|
30
|
+
interactive: bool = True,
|
|
31
|
+
dark_mode: bool = False,
|
|
32
|
+
collapsible_sections: bool = True,
|
|
33
|
+
responsive: bool = True,
|
|
34
|
+
self_contained: bool = True,
|
|
35
|
+
) -> str:
|
|
36
|
+
"""Generate modern HTML report.
|
|
37
|
+
|
|
38
|
+
Args:
|
|
39
|
+
report: Report object to render.
|
|
40
|
+
interactive: Enable interactive features (sorting, filtering).
|
|
41
|
+
dark_mode: Include dark mode support.
|
|
42
|
+
collapsible_sections: Make sections collapsible.
|
|
43
|
+
responsive: Enable responsive design for mobile.
|
|
44
|
+
self_contained: Include all assets inline (no external dependencies).
|
|
45
|
+
|
|
46
|
+
Returns:
|
|
47
|
+
HTML string.
|
|
48
|
+
"""
|
|
49
|
+
html_parts = [
|
|
50
|
+
_generate_html_header(report, dark_mode, responsive),
|
|
51
|
+
_generate_html_styles(dark_mode, responsive),
|
|
52
|
+
_generate_html_scripts() if interactive or collapsible_sections else "",
|
|
53
|
+
"</head>",
|
|
54
|
+
"<body>",
|
|
55
|
+
_generate_html_nav(report) if len(report.sections) > 3 else "",
|
|
56
|
+
'<div class="container">',
|
|
57
|
+
f"<header><h1>{report.config.title}</h1>",
|
|
58
|
+
_generate_metadata_section(report),
|
|
59
|
+
"</header>",
|
|
60
|
+
_generate_html_content(report, collapsible_sections),
|
|
61
|
+
"</div>",
|
|
62
|
+
"</body>",
|
|
63
|
+
"</html>",
|
|
64
|
+
]
|
|
65
|
+
|
|
66
|
+
return "\n".join(html_parts)
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
def _generate_html_header(report: Report, dark_mode: bool, responsive: bool) -> str:
|
|
70
|
+
"""Generate HTML header."""
|
|
71
|
+
return f"""<!DOCTYPE html>
|
|
72
|
+
<html lang="en">
|
|
73
|
+
<head>
|
|
74
|
+
<meta charset="UTF-8">
|
|
75
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
76
|
+
<meta name="author" content="{report.config.author or "TraceKit"}">
|
|
77
|
+
<meta name="generator" content="TraceKit Reporting System">
|
|
78
|
+
<title>{report.config.title}</title>"""
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
def _generate_html_styles(dark_mode: bool, responsive: bool) -> str:
|
|
82
|
+
"""Generate CSS styles for HTML report."""
|
|
83
|
+
styles = """
|
|
84
|
+
<style>
|
|
85
|
+
/* Professional Formatting Standards */
|
|
86
|
+
:root {
|
|
87
|
+
--primary-color: #2c3e50;
|
|
88
|
+
--secondary-color: #3498db;
|
|
89
|
+
--success-color: #27ae60;
|
|
90
|
+
--warning-color: #f39c12;
|
|
91
|
+
--danger-color: #e74c3c;
|
|
92
|
+
--bg-color: #ffffff;
|
|
93
|
+
--text-color: #333333;
|
|
94
|
+
--border-color: #dddddd;
|
|
95
|
+
--table-header-bg: #f2f2f2;
|
|
96
|
+
--table-alt-row-bg: #f9f9f9;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
/* Dark mode support */
|
|
100
|
+
@media (prefers-color-scheme: dark) {
|
|
101
|
+
body.dark-mode {
|
|
102
|
+
--bg-color: #1e1e1e;
|
|
103
|
+
--text-color: #e0e0e0;
|
|
104
|
+
--border-color: #444444;
|
|
105
|
+
--table-header-bg: #2d2d2d;
|
|
106
|
+
--table-alt-row-bg: #252525;
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
* {
|
|
111
|
+
box-sizing: border-box;
|
|
112
|
+
margin: 0;
|
|
113
|
+
padding: 0;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
body {
|
|
117
|
+
font-family: 'Times New Roman', Times, serif;
|
|
118
|
+
font-size: 10pt;
|
|
119
|
+
line-height: 1.5;
|
|
120
|
+
color: var(--text-color);
|
|
121
|
+
background-color: var(--bg-color);
|
|
122
|
+
margin: 0;
|
|
123
|
+
padding: 0;
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
.container {
|
|
127
|
+
max-width: 1200px;
|
|
128
|
+
margin: 0 auto;
|
|
129
|
+
padding: 1in;
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
/* Typography */
|
|
133
|
+
h1, h2, h3, h4, h5, h6 {
|
|
134
|
+
font-family: Arial, Helvetica, sans-serif;
|
|
135
|
+
line-height: 1.2;
|
|
136
|
+
margin-top: 1em;
|
|
137
|
+
margin-bottom: 0.5em;
|
|
138
|
+
color: var(--primary-color);
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
h1 { font-size: 24pt; }
|
|
142
|
+
h2 { font-size: 18pt; border-bottom: 2px solid var(--border-color); padding-bottom: 0.3em; }
|
|
143
|
+
h3 { font-size: 14pt; }
|
|
144
|
+
h4 { font-size: 12pt; }
|
|
145
|
+
|
|
146
|
+
code, pre {
|
|
147
|
+
font-family: 'Courier New', Courier, monospace;
|
|
148
|
+
background-color: var(--table-alt-row-bg);
|
|
149
|
+
padding: 2px 4px;
|
|
150
|
+
border-radius: 3px;
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
pre {
|
|
154
|
+
padding: 10px;
|
|
155
|
+
overflow-x: auto;
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
/* Visual Emphasis */
|
|
159
|
+
.pass {
|
|
160
|
+
color: var(--success-color);
|
|
161
|
+
font-weight: bold;
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
.fail {
|
|
165
|
+
color: var(--danger-color);
|
|
166
|
+
font-weight: bold;
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
.warning {
|
|
170
|
+
color: var(--warning-color);
|
|
171
|
+
font-weight: bold;
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
.pass::before { content: '\\2713 '; }
|
|
175
|
+
.fail::before { content: '\\2717 '; }
|
|
176
|
+
|
|
177
|
+
/* Severity indicators */
|
|
178
|
+
.severity-critical {
|
|
179
|
+
background-color: rgba(231, 76, 60, 0.2);
|
|
180
|
+
border-left: 4px solid var(--danger-color);
|
|
181
|
+
padding: 10px;
|
|
182
|
+
margin: 10px 0;
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
.severity-warning {
|
|
186
|
+
background-color: rgba(243, 156, 18, 0.2);
|
|
187
|
+
border-left: 4px solid var(--warning-color);
|
|
188
|
+
padding: 10px;
|
|
189
|
+
margin: 10px 0;
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
.severity-info {
|
|
193
|
+
background-color: rgba(52, 152, 219, 0.2);
|
|
194
|
+
border-left: 4px solid var(--secondary-color);
|
|
195
|
+
padding: 10px;
|
|
196
|
+
margin: 10px 0;
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
/* Callout boxes */
|
|
200
|
+
.callout {
|
|
201
|
+
background-color: rgba(241, 196, 15, 0.15);
|
|
202
|
+
border: 1px solid var(--warning-color);
|
|
203
|
+
border-radius: 5px;
|
|
204
|
+
padding: 15px;
|
|
205
|
+
margin: 15px 0;
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
.callout-title {
|
|
209
|
+
font-weight: bold;
|
|
210
|
+
margin-bottom: 10px;
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
/* Tables */
|
|
214
|
+
table {
|
|
215
|
+
border-collapse: collapse;
|
|
216
|
+
width: 100%;
|
|
217
|
+
margin: 15px 0;
|
|
218
|
+
font-size: 10pt;
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
th, td {
|
|
222
|
+
border: 1px solid var(--border-color);
|
|
223
|
+
padding: 8px 12px;
|
|
224
|
+
text-align: left;
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
th {
|
|
228
|
+
background-color: var(--table-header-bg);
|
|
229
|
+
font-weight: bold;
|
|
230
|
+
font-family: Arial, Helvetica, sans-serif;
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
tr:nth-child(even) {
|
|
234
|
+
background-color: var(--table-alt-row-bg);
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
tr:hover {
|
|
238
|
+
background-color: rgba(52, 152, 219, 0.1);
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
caption {
|
|
242
|
+
caption-side: bottom;
|
|
243
|
+
font-style: italic;
|
|
244
|
+
padding: 8px;
|
|
245
|
+
text-align: left;
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
/* Collapsible sections */
|
|
249
|
+
.collapsible {
|
|
250
|
+
cursor: pointer;
|
|
251
|
+
user-select: none;
|
|
252
|
+
display: flex;
|
|
253
|
+
align-items: center;
|
|
254
|
+
gap: 8px;
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
.collapsible::before {
|
|
258
|
+
content: '\\25BC';
|
|
259
|
+
display: inline-block;
|
|
260
|
+
transition: transform 0.3s;
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
.collapsible.collapsed::before {
|
|
264
|
+
transform: rotate(-90deg);
|
|
265
|
+
}
|
|
266
|
+
|
|
267
|
+
.collapsible-content {
|
|
268
|
+
max-height: 5000px;
|
|
269
|
+
overflow: hidden;
|
|
270
|
+
transition: max-height 0.3s ease-out;
|
|
271
|
+
}
|
|
272
|
+
|
|
273
|
+
.collapsible-content.collapsed {
|
|
274
|
+
max-height: 0;
|
|
275
|
+
}
|
|
276
|
+
|
|
277
|
+
/* Metadata section */
|
|
278
|
+
.metadata {
|
|
279
|
+
background-color: var(--table-alt-row-bg);
|
|
280
|
+
padding: 15px;
|
|
281
|
+
margin: 20px 0;
|
|
282
|
+
border-radius: 5px;
|
|
283
|
+
font-size: 9pt;
|
|
284
|
+
}
|
|
285
|
+
|
|
286
|
+
.metadata-item {
|
|
287
|
+
display: inline-block;
|
|
288
|
+
margin-right: 20px;
|
|
289
|
+
}
|
|
290
|
+
|
|
291
|
+
/* Navigation */
|
|
292
|
+
nav {
|
|
293
|
+
background-color: var(--primary-color);
|
|
294
|
+
color: white;
|
|
295
|
+
padding: 15px;
|
|
296
|
+
position: sticky;
|
|
297
|
+
top: 0;
|
|
298
|
+
z-index: 1000;
|
|
299
|
+
}
|
|
300
|
+
|
|
301
|
+
nav ul {
|
|
302
|
+
list-style: none;
|
|
303
|
+
display: flex;
|
|
304
|
+
gap: 20px;
|
|
305
|
+
flex-wrap: wrap;
|
|
306
|
+
}
|
|
307
|
+
|
|
308
|
+
nav a {
|
|
309
|
+
color: white;
|
|
310
|
+
text-decoration: none;
|
|
311
|
+
}
|
|
312
|
+
|
|
313
|
+
nav a:hover {
|
|
314
|
+
text-decoration: underline;
|
|
315
|
+
}
|
|
316
|
+
|
|
317
|
+
/* Responsive design */
|
|
318
|
+
@media (max-width: 768px) {
|
|
319
|
+
.container {
|
|
320
|
+
padding: 0.5in;
|
|
321
|
+
}
|
|
322
|
+
|
|
323
|
+
h1 { font-size: 20pt; }
|
|
324
|
+
h2 { font-size: 16pt; }
|
|
325
|
+
h3 { font-size: 12pt; }
|
|
326
|
+
|
|
327
|
+
table {
|
|
328
|
+
font-size: 9pt;
|
|
329
|
+
}
|
|
330
|
+
|
|
331
|
+
nav ul {
|
|
332
|
+
flex-direction: column;
|
|
333
|
+
gap: 10px;
|
|
334
|
+
}
|
|
335
|
+
}
|
|
336
|
+
|
|
337
|
+
/* Print styles */
|
|
338
|
+
@media print {
|
|
339
|
+
.container {
|
|
340
|
+
max-width: 100%;
|
|
341
|
+
padding: 0;
|
|
342
|
+
}
|
|
343
|
+
|
|
344
|
+
nav {
|
|
345
|
+
display: none;
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
.collapsible-content {
|
|
349
|
+
max-height: none !important;
|
|
350
|
+
}
|
|
351
|
+
}
|
|
352
|
+
</style>"""
|
|
353
|
+
return styles
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
def _generate_html_scripts() -> str:
|
|
357
|
+
"""Generate JavaScript for interactive features."""
|
|
358
|
+
return """
|
|
359
|
+
<script>
|
|
360
|
+
// Collapsible sections
|
|
361
|
+
document.addEventListener('DOMContentLoaded', function() {
|
|
362
|
+
const collapsibles = document.querySelectorAll('.collapsible');
|
|
363
|
+
|
|
364
|
+
collapsibles.forEach(function(collapsible) {
|
|
365
|
+
collapsible.addEventListener('click', function() {
|
|
366
|
+
this.classList.toggle('collapsed');
|
|
367
|
+
const content = this.nextElementSibling;
|
|
368
|
+
if (content && content.classList.contains('collapsible-content')) {
|
|
369
|
+
content.classList.toggle('collapsed');
|
|
370
|
+
}
|
|
371
|
+
});
|
|
372
|
+
});
|
|
373
|
+
|
|
374
|
+
// Dark mode toggle
|
|
375
|
+
const darkModeToggle = document.getElementById('dark-mode-toggle');
|
|
376
|
+
if (darkModeToggle) {
|
|
377
|
+
darkModeToggle.addEventListener('click', function() {
|
|
378
|
+
document.body.classList.toggle('dark-mode');
|
|
379
|
+
});
|
|
380
|
+
}
|
|
381
|
+
|
|
382
|
+
// Table sorting (if interactive)
|
|
383
|
+
const tables = document.querySelectorAll('table.sortable');
|
|
384
|
+
tables.forEach(function(table) {
|
|
385
|
+
const headers = table.querySelectorAll('th');
|
|
386
|
+
headers.forEach(function(header, index) {
|
|
387
|
+
header.addEventListener('click', function() {
|
|
388
|
+
sortTable(table, index);
|
|
389
|
+
});
|
|
390
|
+
header.style.cursor = 'pointer';
|
|
391
|
+
});
|
|
392
|
+
});
|
|
393
|
+
});
|
|
394
|
+
|
|
395
|
+
function sortTable(table, column) {
|
|
396
|
+
const tbody = table.querySelector('tbody');
|
|
397
|
+
const rows = Array.from(tbody.querySelectorAll('tr'));
|
|
398
|
+
|
|
399
|
+
rows.sort(function(a, b) {
|
|
400
|
+
const aText = a.cells[column].textContent.trim();
|
|
401
|
+
const bText = b.cells[column].textContent.trim();
|
|
402
|
+
|
|
403
|
+
// Try numeric comparison first
|
|
404
|
+
const aNum = parseFloat(aText);
|
|
405
|
+
const bNum = parseFloat(bText);
|
|
406
|
+
|
|
407
|
+
if (!isNaN(aNum) && !isNaN(bNum)) {
|
|
408
|
+
return aNum - bNum;
|
|
409
|
+
}
|
|
410
|
+
|
|
411
|
+
// Fall back to string comparison
|
|
412
|
+
return aText.localeCompare(bText);
|
|
413
|
+
});
|
|
414
|
+
|
|
415
|
+
rows.forEach(function(row) {
|
|
416
|
+
tbody.appendChild(row);
|
|
417
|
+
});
|
|
418
|
+
}
|
|
419
|
+
</script>"""
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
def _generate_html_nav(report: Report) -> str:
|
|
423
|
+
"""Generate navigation menu."""
|
|
424
|
+
nav_items = []
|
|
425
|
+
for section in report.sections:
|
|
426
|
+
if section.visible:
|
|
427
|
+
section_id = section.title.lower().replace(" ", "-")
|
|
428
|
+
nav_items.append(f'<li><a href="#{section_id}">{section.title}</a></li>')
|
|
429
|
+
|
|
430
|
+
return f"""
|
|
431
|
+
<nav>
|
|
432
|
+
<ul>
|
|
433
|
+
{"".join(nav_items)}
|
|
434
|
+
</ul>
|
|
435
|
+
</nav>"""
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
def _generate_metadata_section(report: Report) -> str:
|
|
439
|
+
"""Generate metadata section."""
|
|
440
|
+
items = []
|
|
441
|
+
if report.config.author:
|
|
442
|
+
items.append(
|
|
443
|
+
f'<span class="metadata-item"><strong>Author:</strong> {report.config.author}</span>'
|
|
444
|
+
)
|
|
445
|
+
items.append(
|
|
446
|
+
f'<span class="metadata-item"><strong>Date:</strong> {report.config.created.strftime("%Y-%m-%d %H:%M")}</span>'
|
|
447
|
+
)
|
|
448
|
+
if report.config.verbosity:
|
|
449
|
+
items.append(
|
|
450
|
+
f'<span class="metadata-item"><strong>Detail Level:</strong> {report.config.verbosity}</span>'
|
|
451
|
+
)
|
|
452
|
+
|
|
453
|
+
return f'<div class="metadata">{" ".join(items)}</div>'
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
def _generate_html_content(report: Report, collapsible: bool) -> str:
|
|
457
|
+
"""Generate main content sections."""
|
|
458
|
+
content = []
|
|
459
|
+
|
|
460
|
+
for section in report.sections:
|
|
461
|
+
if not section.visible:
|
|
462
|
+
continue
|
|
463
|
+
|
|
464
|
+
section_id = section.title.lower().replace(" ", "-")
|
|
465
|
+
content.append(f'<section id="{section_id}">')
|
|
466
|
+
|
|
467
|
+
# Section header
|
|
468
|
+
tag = f"h{min(section.level + 1, 6)}"
|
|
469
|
+
if collapsible and section.collapsible:
|
|
470
|
+
content.append(f'<{tag} class="collapsible">{section.title}</{tag}>')
|
|
471
|
+
content.append('<div class="collapsible-content">')
|
|
472
|
+
else:
|
|
473
|
+
content.append(f"<{tag}>{section.title}</{tag}>")
|
|
474
|
+
|
|
475
|
+
# Section content
|
|
476
|
+
if isinstance(section.content, str):
|
|
477
|
+
content.append(f"<p>{section.content}</p>")
|
|
478
|
+
elif isinstance(section.content, list):
|
|
479
|
+
for item in section.content:
|
|
480
|
+
if isinstance(item, dict):
|
|
481
|
+
if item.get("type") == "table":
|
|
482
|
+
content.append(_table_to_html(item))
|
|
483
|
+
elif item.get("type") == "figure":
|
|
484
|
+
content.append(_figure_to_html(item))
|
|
485
|
+
else:
|
|
486
|
+
content.append(f"<p>{item}</p>")
|
|
487
|
+
|
|
488
|
+
# Subsections
|
|
489
|
+
for subsec in section.subsections:
|
|
490
|
+
if not subsec.visible:
|
|
491
|
+
continue
|
|
492
|
+
sub_tag = f"h{min(subsec.level + 1, 6)}"
|
|
493
|
+
content.append(f"<{sub_tag}>{subsec.title}</{sub_tag}>")
|
|
494
|
+
if isinstance(subsec.content, str):
|
|
495
|
+
content.append(f"<p>{subsec.content}</p>")
|
|
496
|
+
|
|
497
|
+
if collapsible and section.collapsible:
|
|
498
|
+
content.append("</div>")
|
|
499
|
+
|
|
500
|
+
content.append("</section>")
|
|
501
|
+
|
|
502
|
+
return "\n".join(content)
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
def _table_to_html(table: dict[str, Any]) -> str:
|
|
506
|
+
"""Convert table dictionary to HTML."""
|
|
507
|
+
lines = ['<table class="sortable">']
|
|
508
|
+
|
|
509
|
+
headers = table.get("headers", [])
|
|
510
|
+
data = table.get("data", [])
|
|
511
|
+
|
|
512
|
+
if headers:
|
|
513
|
+
lines.append("<thead><tr>")
|
|
514
|
+
for h in headers:
|
|
515
|
+
lines.append(f"<th>{h}</th>")
|
|
516
|
+
lines.append("</tr></thead>")
|
|
517
|
+
|
|
518
|
+
lines.append("<tbody>")
|
|
519
|
+
for row in data:
|
|
520
|
+
lines.append("<tr>")
|
|
521
|
+
for cell in row:
|
|
522
|
+
# Apply visual emphasis for PASS/FAIL
|
|
523
|
+
cell_str = str(cell)
|
|
524
|
+
if "PASS" in cell_str.upper():
|
|
525
|
+
lines.append(f'<td class="pass">{cell}</td>')
|
|
526
|
+
elif "FAIL" in cell_str.upper():
|
|
527
|
+
lines.append(f'<td class="fail">{cell}</td>')
|
|
528
|
+
elif "WARNING" in cell_str.upper():
|
|
529
|
+
lines.append(f'<td class="warning">{cell}</td>')
|
|
530
|
+
else:
|
|
531
|
+
lines.append(f"<td>{cell}</td>")
|
|
532
|
+
lines.append("</tr>")
|
|
533
|
+
lines.append("</tbody>")
|
|
534
|
+
lines.append("</table>")
|
|
535
|
+
|
|
536
|
+
if table.get("caption"):
|
|
537
|
+
lines.append(f"<caption>{table['caption']}</caption>")
|
|
538
|
+
|
|
539
|
+
return "\n".join(lines)
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
def _figure_to_html(figure: dict[str, Any]) -> str:
|
|
543
|
+
"""Convert figure dictionary to HTML."""
|
|
544
|
+
width = figure.get("width", "100%")
|
|
545
|
+
caption = figure.get("caption", "")
|
|
546
|
+
|
|
547
|
+
html = f'<figure style="max-width: {width}; margin: 20px auto;">'
|
|
548
|
+
|
|
549
|
+
# Handle different figure types
|
|
550
|
+
fig_obj = figure.get("figure")
|
|
551
|
+
if isinstance(fig_obj, str):
|
|
552
|
+
# Assume it's a path to an image
|
|
553
|
+
html += f'<img src="{fig_obj}" alt="{caption}" style="width: 100%;">'
|
|
554
|
+
else:
|
|
555
|
+
# Placeholder for matplotlib figures
|
|
556
|
+
html += f'<div class="figure-placeholder">[Figure: {caption}]</div>'
|
|
557
|
+
|
|
558
|
+
if caption:
|
|
559
|
+
html += f"<figcaption>{caption}</figcaption>"
|
|
560
|
+
|
|
561
|
+
html += "</figure>"
|
|
562
|
+
return html
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
def save_html_report(
|
|
566
|
+
report: Report,
|
|
567
|
+
path: str | Path,
|
|
568
|
+
**kwargs: Any,
|
|
569
|
+
) -> None:
|
|
570
|
+
"""Save report as HTML file.
|
|
571
|
+
|
|
572
|
+
Args:
|
|
573
|
+
report: Report object.
|
|
574
|
+
path: Output file path.
|
|
575
|
+
**kwargs: Additional options for generate_html_report.
|
|
576
|
+
"""
|
|
577
|
+
html_content = generate_html_report(report, **kwargs)
|
|
578
|
+
Path(path).write_text(html_content, encoding="utf-8")
|