9b5c8c1c4f
Convert remaining percent formatting and .format() calls to f-strings and fix line length violations to comply with 79 character limit. this also updates the check-merge-conflict pre-commit rule to exclude .rst and .inc files where ===== is valid syntax and not a merge conflict marker. Changes include: - Convert % formatting to f-strings in nova_helper.py and collection.py - Split long f-strings across multiple lines where needed - Use intermediate variables to reduce line length - Replace problematic f-string patterns to avoid false positive N341 violations in gnocchi.py Generated-By: Claude <noreply@anthropic.com> Change-Id: I2cd6c6b5ff7ffb1e800b3f55fe7af42bd878c6b9 Signed-off-by: Sean Mooney <work@seanmooney.info>
133 lines
4.1 KiB
Python
133 lines
4.1 KiB
Python
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
"""
|
|
This provides a sphinx extension able to list the implemented versioned
|
|
notifications into the developer documentation.
|
|
|
|
It is used via a single directive in the .rst file
|
|
|
|
.. versioned_notifications::
|
|
|
|
"""
|
|
|
|
from docutils.parsers.rst import Directive
|
|
from docutils import nodes
|
|
|
|
from watcher.notifications import base as notification
|
|
from watcher.objects import base
|
|
|
|
|
|
class VersionedNotificationDirective(Directive):
|
|
|
|
SAMPLE_ROOT = 'doc/notification_samples/'
|
|
TOGGLE_SCRIPT = """
|
|
<script>
|
|
jQuery(document).ready(function(){
|
|
jQuery('#%s-div').toggle('show');
|
|
jQuery('#%s-hideshow').on('click', function(event) {
|
|
jQuery('#%s-div').toggle('show');
|
|
});
|
|
});
|
|
</script>
|
|
"""
|
|
|
|
def run(self):
|
|
notifications = self._collect_notifications()
|
|
return self._build_markup(notifications)
|
|
|
|
def _collect_notifications(self):
|
|
base.WatcherObjectRegistry.register_notification_objects()
|
|
notifications = []
|
|
ovos = base.WatcherObjectRegistry.obj_classes()
|
|
for name, cls in ovos.items():
|
|
cls = cls[0]
|
|
if (issubclass(cls, notification.NotificationBase) and
|
|
cls != notification.NotificationBase):
|
|
|
|
payload_name = cls.fields['payload'].objname
|
|
payload_cls = ovos[payload_name][0]
|
|
for sample in cls.samples:
|
|
notifications.append((cls.__name__,
|
|
payload_cls.__name__,
|
|
sample))
|
|
return sorted(notifications)
|
|
|
|
def _build_markup(self, notifications):
|
|
content = []
|
|
cols = ['Event type', 'Notification class', 'Payload class', 'Sample']
|
|
table = nodes.table()
|
|
content.append(table)
|
|
group = nodes.tgroup(cols=len(cols))
|
|
table.append(group)
|
|
|
|
head = nodes.thead()
|
|
group.append(head)
|
|
|
|
for _ in cols:
|
|
group.append(nodes.colspec(colwidth=1))
|
|
|
|
body = nodes.tbody()
|
|
group.append(body)
|
|
|
|
# fill the table header
|
|
row = nodes.row()
|
|
body.append(row)
|
|
for col_name in cols:
|
|
col = nodes.entry()
|
|
row.append(col)
|
|
text = nodes.strong(text=col_name)
|
|
col.append(text)
|
|
|
|
# fill the table content, one notification per row
|
|
for name, payload, sample_file in notifications:
|
|
event_type = sample_file[0: -5].replace('-', '.')
|
|
|
|
row = nodes.row()
|
|
body.append(row)
|
|
col = nodes.entry()
|
|
row.append(col)
|
|
text = nodes.literal(text=event_type)
|
|
col.append(text)
|
|
|
|
col = nodes.entry()
|
|
row.append(col)
|
|
text = nodes.literal(text=name)
|
|
col.append(text)
|
|
|
|
col = nodes.entry()
|
|
row.append(col)
|
|
text = nodes.literal(text=payload)
|
|
col.append(text)
|
|
|
|
col = nodes.entry()
|
|
row.append(col)
|
|
|
|
with open(self.SAMPLE_ROOT + sample_file) as f:
|
|
sample_content = f.read()
|
|
|
|
event_type = sample_file[0: -5]
|
|
html_str = self.TOGGLE_SCRIPT % ((event_type, ) * 3)
|
|
html_str += (f"<input type='button' id='{event_type}-hideshow' "
|
|
"value='hide/show sample'>")
|
|
html_str += (f"<div id='{event_type}-div'><pre>{sample_content}</pre></div>")
|
|
|
|
raw = nodes.raw('', html_str, format="html")
|
|
col.append(raw)
|
|
|
|
return content
|
|
|
|
|
|
def setup(app):
|
|
app.add_directive('versioned_notifications',
|
|
VersionedNotificationDirective)
|