Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing docstrings (Claripy) #17

Closed
zardus opened this issue Jun 17, 2016 · 9 comments
Closed

Missing docstrings (Claripy) #17

zardus opened this issue Jun 17, 2016 · 9 comments

Comments

@zardus
Copy link
Member

zardus commented Jun 17, 2016

There are lots of missing module, class, and function docstrings in the angr module. Here is the list. We desperately need help with this from the community, if someone wants to contribute!

Here is the list:

************* Module claripy.balancer
- balancer.py:1 - 
- balancer.py:33 - Balancer.compat_ret
- balancer.py:36 - Balancer._replacements_iter
- balancer.py:47 - Balancer._add_lower_bound
- balancer.py:62 - Balancer._add_upper_bound
- balancer.py:78 - Balancer.replacements
- balancer.py:85 - Balancer._same_bound_bv
- balancer.py:92 - Balancer._cardinality
- balancer.py:96 - Balancer._min
- balancer.py:102 - Balancer._max
- balancer.py:107 - Balancer._range
- balancer.py:111 - Balancer._invert_comparison
- balancer.py:118 - Balancer._align_truism
- balancer.py:146 - Balancer._reverse_comparison
- balancer.py:166 - Balancer._align_bv
- balancer.py:176 - Balancer._align___sub__
- balancer.py:219 - Balancer._queue_truism
- balancer.py:225 - Balancer._queue_truisms
- balancer.py:283 - Balancer._unpack_truisms_And
- balancer.py:286 - Balancer._unpack_truisms_Not
- balancer.py:294 - Balancer._unpack_truisms_Or
- balancer.py:326 - Balancer._balance
- balancer.py:359 - Balancer._balance_Reverse
- balancer.py:366 - Balancer._balance___add__
- balancer.py:374 - Balancer._balance___sub__
- balancer.py:382 - Balancer._balance_ZeroExt
- balancer.py:394 - Balancer._balance_SignExt
- balancer.py:408 - Balancer._balance_Extract
- balancer.py:443 - Balancer._balance_Concat
- balancer.py:457 - Balancer._balance_If
- balancer.py:495 - Balancer._handle
- balancer.py:550 - Balancer._handle___eq__
- balancer.py:564 - Balancer._handle___ne__
- balancer.py:575 - Balancer._handle_If
- balancer.py:594 - is_true
- balancer.py:595 - is_false
************* Module claripy.frontend
- frontend.py:1 - 
- frontend.py:8 - Frontend
- frontend.py:17 - Frontend.uuid
- frontend.py:26 - Frontend.branch
- frontend.py:29 - Frontend._blank_copy
- frontend.py:36 - Frontend.finalize
- frontend.py:39 - Frontend.merge
- frontend.py:42 - Frontend.combine
- frontend.py:45 - Frontend.split
- frontend.py:48 - Frontend.add
- frontend.py:51 - Frontend.simplify
- frontend.py:54 - Frontend.solve
- frontend.py:57 - Frontend.satisfiable
- frontend.py:60 - Frontend.eval_to_ast
- frontend.py:63 - Frontend.eval
- frontend.py:66 - Frontend.batch_eval
- frontend.py:69 - Frontend.max
- frontend.py:72 - Frontend.min
- frontend.py:75 - Frontend.solution
- frontend.py:78 - Frontend.is_true
- frontend.py:81 - Frontend.is_false
- frontend.py:84 - Frontend.downsize
************* Module claripy.annotation
- annotation.py:1 - 
************* Module claripy.ast.vs
- ast/vs.py:1 - 
- ast/vs.py:3 - VS
************* Module claripy.ast.base
- ast/base.py:1 - 
- ast/base.py:21 - _inner_repr
- ast/base.py:27 - ASTCacheKey
- ast/base.py:38 - _make_name
- ast/base.py:172 - Base._get_hashables
- ast/base.py:234 - Base.uuid
- ast/base.py:241 - Base.cache_key
- ast/base.py:273 - Base.make_like
- ast/base.py:280 - Base._rename
- ast/base.py:290 - Base._apply_to_annotations
- ast/base.py:369 - Base.dbg_repr
- ast/base.py:386 - Base._type_name
- ast/base.py:389 - Base.shallow_repr
- ast/base.py:494 - Base.recursive_children_asts
- ast/base.py:503 - Base.recursive_leaf_asts
- ast/base.py:506 - Base._recursive_leaf_asts
- ast/base.py:522 - Base.dbg_is_looped
- ast/base.py:702 - Base._check_replaceability
- ast/base.py:708 - Base._identify_vars
- ast/base.py:720 - Base.canonicalize
- ast/base.py:736 - Base._burrow_ite
- ast/base.py:772 - Base._excavate_ite
- ast/base.py:844 - Base._first_backend
- ast/base.py:853 - Base.singlevalued
- ast/base.py:857 - Base.multivalued
- ast/base.py:861 - Base.cardinality
- ast/base.py:865 - Base.concrete
- ast/base.py:897 - Base.model
- ast/base.py:922 - simplify
************* Module claripy.ast.int
- ast/int.py:1 - 
- ast/int.py:3 - Int
************* Module claripy.ast.fp
- ast/fp.py:1 - 
- ast/fp.py:4 - FP
- ast/fp.py:5 - FP.to_fp
- ast/fp.py:11 - FP.raw_to_fp
- ast/fp.py:14 - FP.to_bv
- ast/fp.py:18 - FP.sort
- ast/fp.py:53 - _fp_length_calc
- ast/fp.py:73 - _fp_cmp_check
- ast/fp.py:85 - _fp_binop_check
- ast/fp.py:87 - _fp_binop_length
************* Module claripy.ast.bits
- ast/bits.py:1 - 
- ast/bits.py:3 - Bits
- ast/bits.py:17 - Bits.size
************* Module claripy.ast.bv
- ast/bv.py:1 - 
- ast/bv.py:8 - cleanup
- ast/bv.py:14 - BV
- ast/bv.py:108 - BV._from_int
- ast/bv.py:112 - BV._from_long
- ast/bv.py:116 - BV._from_str
- ast/bv.py:120 - BV._from_BVV
- ast/bv.py:123 - BV.signed_to_fp
- ast/bv.py:129 - BV.unsigned_to_fp
- ast/bv.py:134 - BV.raw_to_fp
- ast/bv.py:138 - BV.to_bv
- ast/bv.py:201 - SI
- ast/bv.py:210 - TSI
- ast/bv.py:214 - ESI
- ast/bv.py:217 - ValueSet
- ast/bv.py:222 - DSIS
************* Module claripy.ast.bool
- ast/bool.py:1 - 
- ast/bool.py:10 - cleanup
- ast/bool.py:16 - Bool
- ast/bool.py:18 - Bool._from_bool
- ast/bool.py:48 - BoolV
- ast/bool.py:76 - If
- ast/bool.py:130 - is_true
- ast/bool.py:138 - is_false
- ast/bool.py:146 - ite_dict
- ast/bool.py:149 - ite_cases
************* Module claripy.ast
- ast/__init__.py:1 - 
- ast/__init__.py:13 - _import
************* Module claripy.errors
- errors.py:1 - 
- errors.py:1 - ClaripyError
- errors.py:4 - UnsatError
- errors.py:7 - ClaripyFrontendError
- errors.py:10 - ClaripySerializationError
- errors.py:13 - BackendError
- errors.py:16 - ClaripyZ3Error
- errors.py:19 - ClaripyBackendVSAError
- errors.py:26 - ClaripyASTError
- errors.py:29 - ClaripyBalancerError
- errors.py:32 - ClaripyBalancerUnsatError
- errors.py:35 - ClaripyTypeError
- errors.py:38 - ClaripyValueError
- errors.py:41 - ClaripySizeError
- errors.py:44 - ClaripyOperationError
- errors.py:47 - ClaripyReplacementError
- errors.py:50 - ClaripyRecursionError
************* Module claripy.backend_manager
- backend_manager.py:1 - 
- backend_manager.py:1 - BackendManager
- backend_manager.py:9 - BackendManager._register_backend
- backend_manager.py:25 - BackendManager.downsize
************* Module claripy.vsa.errors
- vsa/errors.py:1 - 
- vsa/errors.py:4 - ClaripyVSAError
- vsa/errors.py:7 - ClaripyVSAOperationError
************* Module claripy.vsa.abstract_location
- vsa/abstract_location.py:1 - 
- vsa/abstract_location.py:3 - Segment
- vsa/abstract_location.py:11 - AbstractLocation
- vsa/abstract_location.py:21 - AbstractLocation._add_segment
- vsa/abstract_location.py:73 - AbstractLocation.basicblock_key
- vsa/abstract_location.py:77 - AbstractLocation.statement_id
- vsa/abstract_location.py:81 - AbstractLocation.region
- vsa/abstract_location.py:85 - AbstractLocation.segments
- vsa/abstract_location.py:88 - AbstractLocation.update
- vsa/abstract_location.py:93 - AbstractLocation.copy
- vsa/abstract_location.py:97 - AbstractLocation.merge
************* Module claripy.vsa.bool_result
- vsa/bool_result.py:1 - 
- vsa/bool_result.py:3 - BoolResult
- vsa/bool_result.py:8 - BoolResult.value
- vsa/bool_result.py:26 - BoolResult.identical
- vsa/bool_result.py:35 - BoolResult.union
- vsa/bool_result.py:38 - BoolResult.size
- vsa/bool_result.py:42 - BoolResult.is_maybe
- vsa/bool_result.py:49 - BoolResult.has_true
- vsa/bool_result.py:56 - BoolResult.has_false
- vsa/bool_result.py:63 - BoolResult.is_true
- vsa/bool_result.py:70 - BoolResult.is_false
- vsa/bool_result.py:76 - TrueResult
- vsa/bool_result.py:121 - FalseResult
- vsa/bool_result.py:161 - MaybeResult
************* Module claripy.vsa.valueset
- vsa/valueset.py:1 - 
- vsa/valueset.py:5 - normalize_types
- vsa/valueset.py:21 - normalize_types_one_arg
- vsa/valueset.py:36 - ValueSet
- vsa/valueset.py:69 - ValueSet.name
- vsa/valueset.py:73 - ValueSet.regions
- vsa/valueset.py:77 - ValueSet.reversed
- vsa/valueset.py:81 - ValueSet.unique
- vsa/valueset.py:85 - ValueSet.bits
- vsa/valueset.py:89 - ValueSet.cardinality
- vsa/valueset.py:97 - ValueSet.set_si
- vsa/valueset.py:103 - ValueSet.get_si
- vsa/valueset.py:109 - ValueSet.items
- vsa/valueset.py:112 - ValueSet.size
- vsa/valueset.py:116 - ValueSet.merge_si
- vsa/valueset.py:123 - ValueSet.remove_si
- vsa/valueset.py:254 - ValueSet.eval
- vsa/valueset.py:263 - ValueSet.copy
- vsa/valueset.py:270 - ValueSet.reverse
- vsa/valueset.py:279 - ValueSet.is_empty
- vsa/valueset.py:311 - ValueSet.concat
- vsa/valueset.py:328 - ValueSet.union
- vsa/valueset.py:343 - ValueSet.widen
************* Module claripy.vsa.discrete_strided_interval_set
- vsa/discrete_strided_interval_set.py:1 - 
- vsa/discrete_strided_interval_set.py:8 - apply_on_each_si
- vsa/discrete_strided_interval_set.py:10 - apply_on_each_si.operator
- vsa/discrete_strided_interval_set.py:35 - convert_operand_to_si
- vsa/discrete_strided_interval_set.py:37 - convert_operand_to_si.converter
- vsa/discrete_strided_interval_set.py:47 - collapse_operand
- vsa/discrete_strided_interval_set.py:49 - collapse_operand.collapser
- vsa/discrete_strided_interval_set.py:109 - DiscreteStridedIntervalSet.number_of_values
- vsa/discrete_strided_interval_set.py:120 - DiscreteStridedIntervalSet.should_collapse
- vsa/discrete_strided_interval_set.py:571 - DiscreteStridedIntervalSet._update_bounds
- vsa/discrete_strided_interval_set.py:587 - DiscreteStridedIntervalSet._update_bits
************* Module claripy.vsa.strided_interval
- vsa/strided_interval.py:1 - 
- vsa/strided_interval.py:11 - reversed_processor
- vsa/strided_interval.py:12 - reversed_processor.processor
- vsa/strided_interval.py:21 - normalize_types
- vsa/strided_interval.py:325 - StridedInterval.copy
- vsa/strided_interval.py:336 - StridedInterval.nameless_copy
- vsa/strided_interval.py:347 - StridedInterval.normalize
- vsa/strided_interval.py:405 - StridedInterval._normalize_top
- vsa/strided_interval.py:1074 - StridedInterval.name
- vsa/strided_interval.py:1078 - StridedInterval.reversed
- vsa/strided_interval.py:1082 - StridedInterval.size
- vsa/strided_interval.py:1087 - StridedInterval.cardinality
- vsa/strided_interval.py:1130 - StridedInterval.lower_bound
- vsa/strided_interval.py:1138 - StridedInterval.upper_bound
- vsa/strided_interval.py:1146 - StridedInterval.bits
- vsa/strided_interval.py:1150 - StridedInterval.stride
- vsa/strided_interval.py:1188 - StridedInterval.unique
- vsa/strided_interval.py:1191 - StridedInterval._min_bits
- vsa/strided_interval.py:1234 - StridedInterval.is_interval
- vsa/strided_interval.py:1239 - StridedInterval.n_values
- vsa/strided_interval.py:1247 - StridedInterval._modular_add
- vsa/strided_interval.py:1251 - StridedInterval._modular_sub
- vsa/strided_interval.py:1255 - StridedInterval._modular_mul
- vsa/strided_interval.py:1286 - StridedInterval.highbit
- vsa/strided_interval.py:1290 - StridedInterval.min_bits
- vsa/strided_interval.py:1308 - StridedInterval.max_int
- vsa/strided_interval.py:1312 - StridedInterval.min_int
- vsa/strided_interval.py:1316 - StridedInterval.signed_max_int
- vsa/strided_interval.py:1321 - StridedInterval.signed_min_int
- vsa/strided_interval.py:1326 - StridedInterval._to_negative
- vsa/strided_interval.py:1406 - StridedInterval.empty
- vsa/strided_interval.py:2036 - StridedInterval.bitwise_and.number_of_ones
- vsa/strided_interval.py:2082 - StridedInterval._pre_shift
- vsa/strided_interval.py:2090 - StridedInterval._pre_shift.get_range.round
- vsa/strided_interval.py:2167 - StridedInterval.lshift
- vsa/strided_interval.py:2195 - StridedInterval.cast_low
- vsa/strided_interval.py:2249 - StridedInterval.concat
- vsa/strided_interval.py:2271 - StridedInterval.extract
- vsa/strided_interval.py:2453 - StridedInterval._ntz.bits
- vsa/strided_interval.py:2513 - StridedInterval._union
- vsa/strided_interval.py:2697 - StridedInterval.sign
- vsa/strided_interval.py:2729 - StridedInterval.diop_natural_solution_linear.get_intersection
- vsa/strided_interval.py:2882 - StridedInterval.intersection
- vsa/strided_interval.py:2891 - StridedInterval._multi_valued_intersection
- vsa/strided_interval.py:3077 - StridedInterval.widen
************* Module claripy.vsa
- vsa/__init__.py:1 - 
************* Module claripy.backend
- backend.py:1 - 
- backend.py:63 - Backend._object_cache
- backend.py:70 - Backend._make_raw_ops
- backend.py:185 - Backend.convert_list
- backend.py:243 - Backend.simplify
- backend.py:248 - Backend._simplify
- backend.py:760 - Backend.singlevalued
- backend.py:763 - Backend.multivalued
************* Module claripy.frontends.replacement_frontend
- frontends/replacement_frontend.py:1 - 
- frontends/replacement_frontend.py:11 - ReplacementFrontend
- frontends/replacement_frontend.py:26 - ReplacementFrontend.add_replacement
- frontends/replacement_frontend.py:54 - ReplacementFrontend._replacement
- frontends/replacement_frontend.py:66 - ReplacementFrontend._add_solve_result
- frontends/replacement_frontend.py:130 - ReplacementFrontend._replace_list
************* Module claripy.frontends.light_frontend
- frontends/light_frontend.py:1 - 
- frontends/light_frontend.py:8 - LightFrontend
************* Module claripy.frontends.constrained_frontend
- frontends/constrained_frontend.py:1 - 
- frontends/constrained_frontend.py:10 - ConstrainedFrontend
- frontends/constrained_frontend.py:36 - ConstrainedFrontend.independent_constraints
- frontends/constrained_frontend.py:72 - ConstrainedFrontend._satisfiable
************* Module claripy.frontends.composite_frontend
- frontends/composite_frontend.py:1 - 
- frontends/composite_frontend.py:9 - CompositeFrontend
- frontends/composite_frontend.py:33 - CompositeFrontend._solver_list
- frontends/composite_frontend.py:43 - CompositeFrontend.variables
- frontends/composite_frontend.py:47 - CompositeFrontend.constraints
- frontends/composite_frontend.py:50 - CompositeFrontend._solvers_for_variables
- frontends/composite_frontend.py:62 - CompositeFrontend._merged_solver_for
- frontends/composite_frontend.py:87 - CompositeFrontend._variable_sets
- frontends/composite_frontend.py:90 - CompositeFrontend._shared_varsets
- frontends/composite_frontend.py:99 - CompositeFrontend._add_dependent_constraints
- frontends/composite_frontend.py:149 - CompositeFrontend._all_variables
- frontends/composite_frontend.py:229 - CompositeFrontend.timeout
- frontends/composite_frontend.py:240 - CompositeFrontend._solver_backend
************* Module claripy.frontends.full_frontend
- frontends/full_frontend.py:1 - 
- frontends/full_frontend.py:11 - FullFrontend
- frontends/full_frontend.py:38 - FullFrontend._get_solver
************* Module claripy.frontends.caching_frontend
- frontends/caching_frontend.py:1 - 
- frontends/caching_frontend.py:11 - CachingFrontend
- frontends/caching_frontend.py:87 - CachingFrontend._filter_single_constraint
- frontends/caching_frontend.py:99 - CachingFrontend._constraint_filter
- frontends/caching_frontend.py:113 - CachingFrontend._add_constraints
- frontends/caching_frontend.py:116 - CachingFrontend._simplify
- frontends/caching_frontend.py:119 - CachingFrontend._solve
- frontends/caching_frontend.py:122 - CachingFrontend._eval
- frontends/caching_frontend.py:125 - CachingFrontend._batch_eval
- frontends/caching_frontend.py:128 - CachingFrontend._min
- frontends/caching_frontend.py:131 - CachingFrontend._max
- frontends/caching_frontend.py:134 - CachingFrontend._solution
- frontends/caching_frontend.py:137 - CachingFrontend._is_true
- frontends/caching_frontend.py:140 - CachingFrontend._is_false
- frontends/caching_frontend.py:159 - CachingFrontend._cache_eval
- frontends/caching_frontend.py:167 - CachingFrontend._cache_max
- frontends/caching_frontend.py:174 - CachingFrontend._cache_min
- frontends/caching_frontend.py:291 - CachingFrontend._eager_resolution
************* Module claripy.frontends.hybrid_frontend
- frontends/hybrid_frontend.py:1 - 
- frontends/hybrid_frontend.py:11 - HybridFrontend
- frontends/hybrid_frontend.py:26 - HybridFrontend.constraints
- frontends/hybrid_frontend.py:30 - HybridFrontend.variables
- frontends/hybrid_frontend.py:34 - HybridFrontend.result
- frontends/hybrid_frontend.py:45 - HybridFrontend._hook_exact_frontend
- frontends/hybrid_frontend.py:46 - HybridFrontend._hook_exact_frontend.constraint_hook
- frontends/hybrid_frontend.py:70 - HybridFrontend._hybrid_call
- frontends/hybrid_frontend.py:158 - hybrid_vsa_z3
************* Module claripy.frontends
- frontends/__init__.py:1 - 
************* Module claripy.backend_object
- backend_object.py:1 - 
************* Module claripy.backends.backendremote
- backends/backendremote.py:1 - 
- backends/backendremote.py:10 - TrackingSolver
- backends/backendremote.py:15 - TrackingSolver.plus_extra
- backends/backendremote.py:19 - get
- backends/backendremote.py:25 - BackendRemote
- backends/backendremote.py:44 - BackendRemote.resolve
************* Module claripy.backends.backend_z3_parallel
- backends/backend_z3_parallel.py:1 - 
- backends/backend_z3_parallel.py:12 - BackendZ3Parallel
- backends/backend_z3_parallel.py:19 - BackendZ3Parallel._background
- backends/backend_z3_parallel.py:74 - BackendZ3Parallel._synchronize
- backends/backend_z3_parallel.py:86 - BackendZ3Parallel._translate
- backends/backend_z3_parallel.py:105 - BackendZ3Parallel.abstract
- backends/backend_z3_parallel.py:119 - BackendZ3Parallel.resolve
************* Module claripy.backends.backend_vsa
- backends/backend_vsa.py:1 - 
- backends/backend_vsa.py:9 - arg_filter
- backends/backend_vsa.py:11 - arg_filter.filter
- backends/backend_vsa.py:18 - normalize_arg_order
- backends/backend_vsa.py:20 - normalize_arg_order.normalizer
- backends/backend_vsa.py:33 - normalize_reversed_arguments
- backends/backend_vsa.py:35 - normalize_reversed_arguments.normalizer
- backends/backend_vsa.py:70 - BackendVSA
- backends/backend_vsa.py:95 - BackendVSA._op_add
- backends/backend_vsa.py:98 - BackendVSA._op_sub
- backends/backend_vsa.py:101 - BackendVSA._op_mul
- backends/backend_vsa.py:104 - BackendVSA._op_or
- backends/backend_vsa.py:107 - BackendVSA._op_xor
- backends/backend_vsa.py:110 - BackendVSA._op_and
- backends/backend_vsa.py:203 - BackendVSA._unique
- backends/backend_vsa.py:221 - BackendVSA.BVV
- backends/backend_vsa.py:228 - BackendVSA.BoolV
- backends/backend_vsa.py:232 - BackendVSA.And
- backends/backend_vsa.py:236 - BackendVSA.Not
- backends/backend_vsa.py:241 - BackendVSA.ULT
- backends/backend_vsa.py:246 - BackendVSA.ULE
- backends/backend_vsa.py:251 - BackendVSA.UGT
- backends/backend_vsa.py:256 - BackendVSA.UGE
- backends/backend_vsa.py:261 - BackendVSA.SLT
- backends/backend_vsa.py:266 - BackendVSA.SLE
- backends/backend_vsa.py:271 - BackendVSA.SGT
- backends/backend_vsa.py:276 - BackendVSA.SGE
- backends/backend_vsa.py:280 - BackendVSA.BVS
- backends/backend_vsa.py:287 - BackendVSA.If
- backends/backend_vsa.py:298 - BackendVSA.Or
- backends/backend_vsa.py:311 - BackendVSA.LShR
- backends/backend_vsa.py:315 - BackendVSA.Concat
- backends/backend_vsa.py:333 - BackendVSA.Extract
- backends/backend_vsa.py:346 - BackendVSA.SignExt
- backends/backend_vsa.py:356 - BackendVSA.ZeroExt
- backends/backend_vsa.py:366 - BackendVSA.Reverse
- backends/backend_vsa.py:373 - BackendVSA.union
- backends/backend_vsa.py:385 - BackendVSA.intersection
- backends/backend_vsa.py:399 - BackendVSA.widen
- backends/backend_vsa.py:410 - BackendVSA.CreateTopStridedInterval
- backends/backend_vsa.py:413 - BackendVSA.constraint_to_si
************* Module claripy.backends.backend_concrete
- backends/backend_concrete.py:1 - 
- backends/backend_concrete.py:7 - BackendConcrete
- backends/backend_concrete.py:26 - BackendConcrete.BVV
- backends/backend_concrete.py:32 - BackendConcrete.FPV
- backends/backend_concrete.py:36 - BackendConcrete._op_add
- backends/backend_concrete.py:39 - BackendConcrete._op_sub
- backends/backend_concrete.py:42 - BackendConcrete._op_mul
- backends/backend_concrete.py:45 - BackendConcrete._op_or
- backends/backend_concrete.py:48 - BackendConcrete._op_xor
- backends/backend_concrete.py:51 - BackendConcrete._op_and
- backends/backend_concrete.py:55 - BackendConcrete.BVS
- backends/backend_concrete.py:70 - BackendConcrete._If
- backends/backend_concrete.py:122 - BackendConcrete._to_primitive
************* Module claripy.backends.celeryconfig
- backends/celeryconfig.py:1 - 
************* Module claripy.backends.backend_z3
- backends/backend_z3.py:1 - 
- backends/backend_z3.py:57 - condom
- backends/backend_z3.py:70 - _raw_caller
- backends/backend_z3.py:73 - _raw_caller.raw_caller
- backends/backend_z3.py:77 - BackendZ3
- backends/backend_z3.py:115 - BackendZ3._context
- backends/backend_z3.py:123 - BackendZ3._ast_cache
- backends/backend_z3.py:131 - BackendZ3._var_cache
- backends/backend_z3.py:139 - BackendZ3._sym_cache
- backends/backend_z3.py:147 - BackendZ3._simplification_cache_key
- backends/backend_z3.py:155 - BackendZ3._simplification_cache_val
- backends/backend_z3.py:187 - BackendZ3.BVS
- backends/backend_z3.py:200 - BackendZ3.BVV
- backends/backend_z3.py:209 - BackendZ3.FPS
- backends/backend_z3.py:213 - BackendZ3.FPV
- backends/backend_z3.py:231 - BackendZ3.BoolS
- backends/backend_z3.py:235 - BackendZ3.BoolV
- backends/backend_z3.py:294 - BackendZ3._abstract_internal
- backends/backend_z3.py:438 - BackendZ3._abstract_to_primitive
- backends/backend_z3.py:479 - BackendZ3._check_and_model
- backends/backend_z3.py:500 - BackendZ3._primitive_from_model
- backends/backend_z3.py:766 - BackendZ3._op_add
- backends/backend_z3.py:769 - BackendZ3._op_sub
- backends/backend_z3.py:772 - BackendZ3._op_mul
- backends/backend_z3.py:775 - BackendZ3._op_or
- backends/backend_z3.py:778 - BackendZ3._op_xor
- backends/backend_z3.py:781 - BackendZ3._op_and
- backends/backend_z3.py:784 - BackendZ3._op_raw_And
- backends/backend_z3.py:787 - BackendZ3._op_raw_Or
- backends/backend_z3.py:790 - BackendZ3._op_raw_Not
- backends/backend_z3.py:793 - BackendZ3._op_raw_If
- backends/backend_z3.py:797 - BackendZ3._op_raw_fpToSBV
- backends/backend_z3.py:801 - BackendZ3._op_raw_fpToUBV
- backends/backend_z3.py:833 - BackendZ3._op_raw_Reverse
- backends/backend_z3.py:843 - BackendZ3._op_raw_SLT
- backends/backend_z3.py:848 - BackendZ3._op_raw_SLE
- backends/backend_z3.py:853 - BackendZ3._op_raw_SGT
- backends/backend_z3.py:858 - BackendZ3._op_raw_SGE
************* Module claripy.backends.remotetasks
- backends/remotetasks.py:1 - 
- backends/remotetasks.py:21 - init_z3_and_conns
- backends/remotetasks.py:27 - flip_dict
- backends/remotetasks.py:30 - canonicalize_all
- backends/remotetasks.py:35 - split_and_canonicalize
- backends/remotetasks.py:48 - check
- backends/remotetasks.py:81 - eval
- backends/remotetasks.py:88 - batch_eval
- backends/remotetasks.py:94 - rename_model
- backends/remotetasks.py:104 - report_sat
- backends/remotetasks.py:106 - report_sat.wrapped
- backends/remotetasks.py:112 - mongo_superset
- backends/remotetasks.py:118 - results
- backends/remotetasks.py:182 - min
- backends/remotetasks.py:189 - max
************* Module claripy.backends
- backends/__init__.py:1 - 
************* Module claripy.ops
- ops.py:1 - 
- ops.py:8 - AbstractLocation
************* Module claripy.operations
- operations.py:1 - 
- operations.py:2 - op
- operations.py:10 - op._type_fixer
- operations.py:36 - op._op
- operations.py:86 - reversed_op
- operations.py:87 - reversed_op._reversed_op
- operations.py:96 - preprocess_union
- operations.py:117 - if_simplifier
- operations.py:124 - concat_simplifier
- operations.py:190 - rshift_simplifier
- operations.py:194 - lshift_simplifier
- operations.py:200 - eq_simplifier
- operations.py:254 - ne_simplifier
- operations.py:298 - boolean_reverse_simplifier
- operations.py:322 - boolean_and_simplifier
- operations.py:338 - boolean_or_simplifier
- operations.py:354 - _flatten_simplifier
- operations.py:363 - bitwise_add_simplifier
- operations.py:371 - bitwise_mul_simplifier
- operations.py:374 - bitwise_sub_simplifier
- operations.py:380 - bitwise_xor_simplifier
- operations.py:390 - bitwise_or_simplifier
- operations.py:402 - bitwise_and_simplifier
- operations.py:414 - boolean_not_simplifier
- operations.py:453 - zeroext_simplifier
- operations.py:457 - signext_simplifier
- operations.py:463 - extract_simplifier
- operations.py:572 - length_same_check
- operations.py:575 - basic_length_calc
- operations.py:578 - extract_check
- operations.py:588 - extract_length_calc
- operations.py:591 - ext_length_calc
- operations.py:594 - concat_length_calc
************* Module claripy.fp
- fp.py:1 - 
- fp.py:7 - compare_sorts
- fp.py:9 - compare_sorts.compare_guard
- fp.py:16 - normalize_types
- fp.py:18 - normalize_types.normalize_helper
- fp.py:29 - RM
- fp.py:31 - RM.default
- fp.py:35 - RM.from_name
- fp.py:50 - FSort
- fp.py:63 - FSort.length
- fp.py:67 - FSort.from_size
- fp.py:76 - FSort.from_params
- fp.py:88 - FPV
- fp.py:217 - fpToFP
- fp.py:238 - fpToFPUnsigned
- fp.py:242 - fpToIEEEBV
- fp.py:255 - fpFP
- fp.py:271 - fpToSBV
- fp.py:282 - fpToUBV
- fp.py:294 - fpEQ
- fp.py:297 - fpNE
- fp.py:300 - fpGT
- fp.py:303 - fpGEQ
- fp.py:306 - fpLT
- fp.py:309 - fpLEQ
- fp.py:312 - fpAbs
- fp.py:315 - fpNeg
- fp.py:318 - fpSub
- fp.py:321 - fpAdd
- fp.py:324 - fpMul
- fp.py:327 - fpDiv
************* Module claripy.bv
- bv.py:1 - 
- bv.py:5 - compare_bits
- bv.py:7 - compare_bits.compare_guard
- bv.py:17 - compare_bits_0_length
- bv.py:19 - compare_bits_0_length.compare_guard
- bv.py:26 - normalize_types
- bv.py:28 - normalize_types.normalize_helper
- bv.py:42 - BVV
- bv.py:69 - BVV.value
- bv.py:77 - BVV.signed
- bv.py:247 - BVV.size
- bv.py:257 - BitVecVal
- bv.py:260 - ZeroExt
- bv.py:263 - SignExt
- bv.py:266 - Extract
- bv.py:269 - Concat
- bv.py:278 - RotateRight
- bv.py:281 - RotateLeft
- bv.py:284 - Reverse
- bv.py:303 - ULT
- bv.py:308 - UGT
- bv.py:313 - ULE
- bv.py:318 - UGE
- bv.py:323 - SLT
- bv.py:328 - SGT
- bv.py:333 - SLE
- bv.py:338 - SGE
- bv.py:346 - BoolV
- bv.py:349 - And
- bv.py:352 - Or
- bv.py:355 - Not
- bv.py:359 - normalizer
- bv.py:362 - If
- bv.py:369 - LShR
************* Module claripy.result
- result.py:1 - 
- result.py:7 - Result
- result.py:20 - Result.resolve_cache
- result.py:26 - Result.backend_model
- result.py:32 - Result.branch
- result.py:49 - Result.downsize
- result.py:52 - UnsatResult
- result.py:55 - SatResult
************* Module claripy
- __init__.py:1 - 
- __init__.py:67 - BV
- __init__.py:92 - downsize
- __init__.py:95 - Solver
@zardus zardus changed the title Missing docstrings (claripy) Missing docstrings (Claripy) Jun 17, 2016
@kwalberg
Copy link

kwalberg commented Jul 11, 2018

I'm interested in doing some work on this issue. Is the list of missing docstrings here up-to-date?

@rhelmot
Copy link
Member

rhelmot commented Jul 12, 2018

It is probably pretty close to up to date. The list was probably generated by running an automated tool, so @zardus could provide a way to check for sure. I doubt the situation has changed much though.

I would keep in mind that most of these functions aren't user-facing interfaces, so I would prioritizing this by just looking through dir(claripy) and seeing what's undocumented.

@saullocarvalho
Copy link
Contributor

saullocarvalho commented May 19, 2019

I'm interested in doing some work on this issue. Is there an updated list of missing docstrings?

@rhelmot
Copy link
Member

rhelmot commented May 19, 2019

@zardus pls post your script for producing this list

@twizmwazin
Copy link
Member

twizmwazin commented May 19, 2019

I think something like pylint might be able to generate a warning for each missing or improperly formatted docstring? Then filtering by just that warning might be able to produce a comprehensive list.

@zardus
Copy link
Member Author

zardus commented May 19, 2019

@github-actions
Copy link

github-actions bot commented Jun 1, 2022

This issue has been marked as stale because it has no recent activity. Please comment or add the pinned tag to prevent this issue from being closed.

@github-actions github-actions bot added the stale label Jun 1, 2022
@rhelmot rhelmot removed the stale label Jun 1, 2022
@github-actions
Copy link

github-actions bot commented Aug 1, 2022

This issue has been marked as stale because it has no recent activity. Please comment or add the pinned tag to prevent this issue from being closed.

@github-actions github-actions bot added the stale label Aug 1, 2022
@github-actions
Copy link

github-actions bot commented Aug 9, 2022

This issue has been closed due to inactivity.

@github-actions github-actions bot closed this as completed Aug 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants