1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
|
"""
codegen.py generates pika/spec.py
The required spec json file can be found at
https://github.com/rabbitmq/rabbitmq-codegen
.
After cloning it run the following to generate a spec.py file:
python2 ./codegen.py ../../rabbitmq-codegen
"""
from __future__ import nested_scopes
import os
import re
import sys
if sys.version_info.major != 2:
sys.exit('Python 2 is required at this time')
RABBITMQ_CODEGEN_PATH = sys.argv[1]
PIKA_SPEC = '../pika/spec.py'
print('codegen-path: %s' % RABBITMQ_CODEGEN_PATH)
sys.path.append(RABBITMQ_CODEGEN_PATH)
import amqp_codegen
DRIVER_METHODS = {
"Exchange.Bind": ["Exchange.BindOk"],
"Exchange.Unbind": ["Exchange.UnbindOk"],
"Exchange.Declare": ["Exchange.DeclareOk"],
"Exchange.Delete": ["Exchange.DeleteOk"],
"Queue.Declare": ["Queue.DeclareOk"],
"Queue.Bind": ["Queue.BindOk"],
"Queue.Purge": ["Queue.PurgeOk"],
"Queue.Delete": ["Queue.DeleteOk"],
"Queue.Unbind": ["Queue.UnbindOk"],
"Basic.Qos": ["Basic.QosOk"],
"Basic.Get": ["Basic.GetOk", "Basic.GetEmpty"],
"Basic.Ack": [],
"Basic.Reject": [],
"Basic.Recover": ["Basic.RecoverOk"],
"Basic.RecoverAsync": [],
"Tx.Select": ["Tx.SelectOk"],
"Tx.Commit": ["Tx.CommitOk"],
"Tx.Rollback": ["Tx.RollbackOk"]
}
def fieldvalue(v):
if isinstance(v, unicode):
return repr(v.encode('ascii'))
elif isinstance(v, dict):
return repr(None)
elif isinstance(v, list):
return repr(None)
else:
return repr(v)
def normalize_separators(s):
s = s.replace('-', '_')
s = s.replace(' ', '_')
return s
def pyize(s):
s = normalize_separators(s)
if s in ('global', 'class'):
s += '_'
if s == 'global_':
s = 'global_qos'
return s
def camel(s):
return normalize_separators(s).title().replace('_', '')
amqp_codegen.AmqpMethod.structName = lambda m: camel(m.klass.name) + '.' + camel(m.name)
amqp_codegen.AmqpClass.structName = lambda c: camel(c.name) + "Properties"
def constantName(s):
return '_'.join(re.split('[- ]', s.upper()))
def flagName(c, f):
if c:
return c.structName() + '.' + constantName('flag_' + f.name)
else:
return constantName('flag_' + f.name)
def generate(specPath):
spec = amqp_codegen.AmqpSpec(specPath)
def genSingleDecode(prefix, cLvalue, unresolved_domain):
type = spec.resolveDomain(unresolved_domain)
if type == 'shortstr':
print(prefix +
"%s, offset = data.decode_short_string(encoded, offset)" %
cLvalue)
elif type == 'longstr':
print(prefix +
"length = struct.unpack_from('>I', encoded, offset)[0]")
print(prefix + "offset += 4")
print(prefix + "%s = encoded[offset:offset + length]" % cLvalue)
print(prefix + "try:")
print(prefix + " %s = str(%s)" % (cLvalue, cLvalue))
print(prefix + "except UnicodeEncodeError:")
print(prefix + " pass")
print(prefix + "offset += length")
elif type == 'octet':
print(prefix +
"%s = struct.unpack_from('B', encoded, offset)[0]" % cLvalue)
print(prefix + "offset += 1")
elif type == 'short':
print(prefix +
"%s = struct.unpack_from('>H', encoded, offset)[0]" % cLvalue)
print(prefix + "offset += 2")
elif type == 'long':
print(prefix +
"%s = struct.unpack_from('>I', encoded, offset)[0]" % cLvalue)
print(prefix + "offset += 4")
elif type == 'longlong':
print(prefix +
"%s = struct.unpack_from('>Q', encoded, offset)[0]" % cLvalue)
print(prefix + "offset += 8")
elif type == 'timestamp':
print(prefix +
"%s = struct.unpack_from('>Q', encoded, offset)[0]" % cLvalue)
print(prefix + "offset += 8")
elif type == 'bit':
raise Exception("Can't decode bit in genSingleDecode")
elif type == 'table':
print(
Exception(prefix +
"(%s, offset) = data.decode_table(encoded, offset)" %
cLvalue))
else:
raise Exception("Illegal domain in genSingleDecode", type)
def genSingleEncode(prefix, cValue, unresolved_domain):
type = spec.resolveDomain(unresolved_domain)
if type == 'shortstr':
print(
prefix +
"assert isinstance(%s, str_or_bytes),\\\n%s 'A non-string value was supplied for %s'"
% (cValue, prefix, cValue))
print(prefix + "data.encode_short_string(pieces, %s)" % cValue)
elif type == 'longstr':
print(
prefix +
"assert isinstance(%s, str_or_bytes),\\\n%s 'A non-string value was supplied for %s'"
% (cValue, prefix, cValue))
print(
prefix +
"value = %s.encode('utf-8') if isinstance(%s, unicode_type) else %s"
% (cValue, cValue, cValue))
print(prefix + "pieces.append(struct.pack('>I', len(value)))")
print(prefix + "pieces.append(value)")
elif type == 'octet':
print(prefix + "pieces.append(struct.pack('B', %s))" % cValue)
elif type == 'short':
print(prefix + "pieces.append(struct.pack('>H', %s))" % cValue)
elif type == 'long':
print(prefix + "pieces.append(struct.pack('>I', %s))" % cValue)
elif type == 'longlong':
print(prefix + "pieces.append(struct.pack('>Q', %s))" % cValue)
elif type == 'timestamp':
print(prefix + "pieces.append(struct.pack('>Q', %s))" % cValue)
elif type == 'bit':
raise Exception("Can't encode bit in genSingleEncode")
elif type == 'table':
print(Exception(prefix + "data.encode_table(pieces, %s)" % cValue))
else:
raise Exception("Illegal domain in genSingleEncode", type)
def genDecodeMethodFields(m):
print(" def decode(self, encoded, offset=0):")
bitindex = None
for f in m.arguments:
if spec.resolveDomain(f.domain) == 'bit':
if bitindex is None:
bitindex = 0
if bitindex >= 8:
bitindex = 0
if not bitindex:
print(
" bit_buffer = struct.unpack_from('B', encoded, offset)[0]"
)
print(" offset += 1")
print(" self.%s = (bit_buffer & (1 << %d)) != 0" %
(pyize(f.name), bitindex))
bitindex += 1
else:
bitindex = None
genSingleDecode(" ", "self.%s" % (pyize(f.name),),
f.domain)
print(" return self")
print('')
def genDecodeProperties(c):
print(" def decode(self, encoded, offset=0):")
print(" flags = 0")
print(" flagword_index = 0")
print(" while True:")
print(
" partial_flags = struct.unpack_from('>H', encoded, offset)[0]"
)
print(" offset += 2")
print(
" flags = flags | (partial_flags << (flagword_index * 16))"
)
print(" if not (partial_flags & 1):")
print(" break")
print(" flagword_index += 1")
for f in c.fields:
if spec.resolveDomain(f.domain) == 'bit':
print(" self.%s = (flags & %s) != 0" % (pyize(f.name),
flagName(c, f)))
else:
print(" if flags & %s:" % (flagName(c, f),))
genSingleDecode(" ", "self.%s" % (pyize(f.name),),
f.domain)
print(" else:")
print(" self.%s = None" % (pyize(f.name),))
print(" return self")
print('')
def genEncodeMethodFields(m):
print(" def encode(self):")
print(" pieces = list()")
bitindex = None
def finishBits():
if bitindex is not None:
print(" pieces.append(struct.pack('B', bit_buffer))")
for f in m.arguments:
if spec.resolveDomain(f.domain) == 'bit':
if bitindex is None:
bitindex = 0
print(" bit_buffer = 0")
if bitindex >= 8:
finishBits()
print(" bit_buffer = 0")
bitindex = 0
print(" if self.%s:" % pyize(f.name))
print(" bit_buffer |= 1 << %d" % bitindex)
bitindex += 1
else:
finishBits()
bitindex = None
genSingleEncode(" ", "self.%s" % (pyize(f.name),),
f.domain)
finishBits()
print(" return pieces")
print('')
def genEncodeProperties(c):
print(" def encode(self):")
print(" pieces = list()")
print(" flags = 0")
for f in c.fields:
if spec.resolveDomain(f.domain) == 'bit':
print(" if self.%s: flags = flags | %s" % (pyize(
f.name), flagName(c, f)))
else:
print(" if self.%s is not None:" % (pyize(f.name),))
print(" flags = flags | %s" % (flagName(c, f),))
genSingleEncode(" ", "self.%s" % (pyize(f.name),),
f.domain)
print(" flag_pieces = list()")
print(" while True:")
print(" remainder = flags >> 16")
print(" partial_flags = flags & 0xFFFE")
print(" if remainder != 0:")
print(" partial_flags |= 1")
print(
" flag_pieces.append(struct.pack('>H', partial_flags))")
print(" flags = remainder")
print(" if not flags:")
print(" break")
print(" return flag_pieces + pieces")
print('')
def fieldDeclList(fields):
return ''.join([
", %s=%s" % (pyize(f.name), fieldvalue(f.defaultvalue))
for f in fields
])
def fieldInitList(prefix, fields):
if fields:
return ''.join(["%sself.%s = %s\n" % (prefix, pyize(f.name), pyize(f.name)) \
for f in fields])
else:
return '%spass\n' % (prefix,)
print("""\"\"\"
AMQP Specification
==================
This module implements the constants and classes that comprise AMQP protocol
level constructs. It should rarely be directly referenced outside of Pika's
own internal use.
.. note:: Auto-generated code by codegen.py, do not edit directly. Pull
requests to this file without accompanying ``utils/codegen.py`` changes will be
rejected.
\"\"\"
import struct
from pika import amqp_object
from pika import data
from pika.compat import str_or_bytes, unicode_type
# Python 3 support for str object
str = bytes
""")
print("PROTOCOL_VERSION = (%d, %d, %d)" % (spec.major, spec.minor,
spec.revision))
print("PORT = %d" % spec.port)
print('')
# Append some constants that arent in the spec json file
spec.constants.append(('FRAME_MAX_SIZE', 131072, ''))
spec.constants.append(('FRAME_HEADER_SIZE', 7, ''))
spec.constants.append(('FRAME_END_SIZE', 1, ''))
spec.constants.append(('TRANSIENT_DELIVERY_MODE', 1, ''))
spec.constants.append(('PERSISTENT_DELIVERY_MODE', 2, ''))
constants = {}
for c, v, cls in spec.constants:
constants[constantName(c)] = v
for key in sorted(constants.keys()):
print("%s = %s" % (key, constants[key]))
print('')
for c in spec.allClasses():
print('')
print('class %s(amqp_object.Class):' % (camel(c.name),))
print('')
print(" INDEX = 0x%.04X # %d" % (c.index, c.index))
print(" NAME = %s" % (fieldvalue(camel(c.name)),))
print('')
for m in c.allMethods():
print(' class %s(amqp_object.Method):' % (camel(m.name),))
print('')
methodid = m.klass.index << 16 | m.index
print(" INDEX = 0x%.08X # %d, %d; %d" %
(methodid, m.klass.index, m.index, methodid))
print(" NAME = %s" % (fieldvalue(m.structName(),)))
print('')
print(
" def __init__(self%s):" % (fieldDeclList(m.arguments),))
print(fieldInitList(' ', m.arguments))
print(" @property")
print(" def synchronous(self):")
print(" return %s" % m.isSynchronous)
print('')
genDecodeMethodFields(m)
genEncodeMethodFields(m)
for c in spec.allClasses():
if c.fields:
print('')
print('class %s(amqp_object.Properties):' % (c.structName(),))
print('')
print(" CLASS = %s" % (camel(c.name),))
print(" INDEX = 0x%.04X # %d" % (c.index, c.index))
print(" NAME = %s" % (fieldvalue(c.structName(),)))
print('')
index = 0
if c.fields:
for f in c.fields:
if index % 16 == 15:
index += 1
shortnum = index / 16
partialindex = 15 - (index % 16)
bitindex = shortnum * 16 + partialindex
print(' %s = (1 << %d)' % (flagName(None, f), bitindex))
index += 1
print('')
print(" def __init__(self%s):" % (fieldDeclList(c.fields),))
print(fieldInitList(' ', c.fields))
genDecodeProperties(c)
genEncodeProperties(c)
print("methods = {")
print(',\n'.join([
" 0x%08X: %s" % (m.klass.index << 16 | m.index, m.structName())
for m in spec.allMethods()
]))
print("}")
print('')
print("props = {")
print(',\n'.join([
" 0x%04X: %s" % (c.index, c.structName())
for c in spec.allClasses()
if c.fields
]))
print("}")
print('')
print('')
print("def has_content(methodNumber):")
print(' return methodNumber in (')
for m in spec.allMethods():
if m.hasContent:
print(' %s.INDEX,' % m.structName())
print(' )')
if __name__ == "__main__":
with open(PIKA_SPEC, 'w') as handle:
sys.stdout = handle
generate(['%s/amqp-rabbitmq-0.9.1.json' % RABBITMQ_CODEGEN_PATH])
|