greenbone /
ospd
| Conditions | 22 |
| Total Lines | 84 |
| Code Lines | 65 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 0 | ||
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
Complex classes like ospd.vts.Vts.add() often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
Methods with many parameters are not only hard to understand, but their parameters also often become inconsistent when you need more, or different data.
There are several approaches to avoid long parameter lists:
| 1 | # Copyright (C) 2020 Greenbone Networks GmbH |
||
| 72 | def add( |
||
| 73 | self, |
||
| 74 | vt_id: str, |
||
| 75 | name: str = None, |
||
| 76 | vt_params: str = None, |
||
| 77 | vt_refs: str = None, |
||
| 78 | custom: str = None, |
||
| 79 | vt_creation_time: str = None, |
||
| 80 | vt_modification_time: str = None, |
||
| 81 | vt_dependencies: str = None, |
||
| 82 | summary: str = None, |
||
| 83 | impact: str = None, |
||
| 84 | affected: str = None, |
||
| 85 | insight: str = None, |
||
| 86 | solution: str = None, |
||
| 87 | solution_t: str = None, |
||
| 88 | solution_m: str = None, |
||
| 89 | detection: str = None, |
||
| 90 | qod_t: str = None, |
||
| 91 | qod_v: str = None, |
||
| 92 | severities: str = None, |
||
| 93 | ) -> None: |
||
| 94 | """ Add a vulnerability test information. |
||
| 95 | |||
| 96 | IMPORTANT: The VT's Data Manager will store the vts collection. |
||
| 97 | If the collection is considerably big and it will be consultated |
||
| 98 | intensible during a routine, consider to do a deepcopy(), since |
||
| 99 | accessing the shared memory in the data manager is very expensive. |
||
| 100 | At the end of the routine, the temporal copy must be set to None |
||
| 101 | and deleted. |
||
| 102 | """ |
||
| 103 | if not vt_id: |
||
| 104 | raise OspdError('Invalid vt_id {}'.format(vt_id)) |
||
| 105 | |||
| 106 | if self.vt_id_pattern.fullmatch(vt_id) is None: |
||
| 107 | raise OspdError('Invalid vt_id {}'.format(vt_id)) |
||
| 108 | |||
| 109 | if vt_id in self.vts: |
||
| 110 | raise OspdError('vt_id {} already exists'.format(vt_id)) |
||
| 111 | |||
| 112 | if name is None: |
||
| 113 | name = '' |
||
| 114 | |||
| 115 | vt = {'name': name} |
||
| 116 | if custom is not None: |
||
| 117 | vt["custom"] = custom |
||
| 118 | if vt_params is not None: |
||
| 119 | vt["vt_params"] = vt_params |
||
| 120 | if vt_refs is not None: |
||
| 121 | vt["vt_refs"] = vt_refs |
||
| 122 | if vt_dependencies is not None: |
||
| 123 | vt["vt_dependencies"] = vt_dependencies |
||
| 124 | if vt_creation_time is not None: |
||
| 125 | vt["creation_time"] = vt_creation_time |
||
| 126 | if vt_modification_time is not None: |
||
| 127 | vt["modification_time"] = vt_modification_time |
||
| 128 | if summary is not None: |
||
| 129 | vt["summary"] = summary |
||
| 130 | if impact is not None: |
||
| 131 | vt["impact"] = impact |
||
| 132 | if affected is not None: |
||
| 133 | vt["affected"] = affected |
||
| 134 | if insight is not None: |
||
| 135 | vt["insight"] = insight |
||
| 136 | |||
| 137 | if solution is not None: |
||
| 138 | vt["solution"] = solution |
||
| 139 | if solution_t is not None: |
||
| 140 | vt["solution_type"] = solution_t |
||
| 141 | if solution_m is not None: |
||
| 142 | vt["solution_method"] = solution_m |
||
| 143 | |||
| 144 | if detection is not None: |
||
| 145 | vt["detection"] = detection |
||
| 146 | |||
| 147 | if qod_t is not None: |
||
| 148 | vt["qod_type"] = qod_t |
||
| 149 | elif qod_v is not None: |
||
| 150 | vt["qod"] = qod_v |
||
| 151 | |||
| 152 | if severities is not None: |
||
| 153 | vt["severities"] = severities |
||
| 154 | |||
| 155 | self.vts[vt_id] = vt |
||
| 156 | |||
| 171 |
