/ipyparallel/factory.py

https://github.com/ipython/ipyparallel
Python | 73 lines | 42 code | 11 blank | 20 comment | 3 complexity | b959d2705dfd66bfff504ff2cfabb9fe MD5 | raw file
    

  1. """Base config factories.
    2. 

    3. 

  3. Authors:
    4. 

  4. 

  5. * Min RK
    6. 

  6. """
    7. 

    8. 

  8. #-----------------------------------------------------------------------------
    9. 

  9. #  Copyright (C) 2010-2011  The IPython Development Team
    10. 

  10. #
    11. 

  11. #  Distributed under the terms of the BSD License.  The full license is in
    12. 

  12. #  the file COPYING, distributed as part of this software.
    13. 

  13. #-----------------------------------------------------------------------------
    14. 

  14. 

  15. #-----------------------------------------------------------------------------
    16. 

  16. # Imports
    17. 

  17. #-----------------------------------------------------------------------------
    18. 

  18. 

  19. from jupyter_client.localinterfaces import localhost
    20. 

  20. from traitlets import Integer, Unicode
    21. 

  21. 

  22. from ipyparallel.util import select_random_ports
    23. 

  23. from jupyter_client.session import SessionFactory
    24. 

  24. 

  25. #-----------------------------------------------------------------------------
    26. 

  26. # Classes
    27. 

  27. #-----------------------------------------------------------------------------
    28. 

  28. 

  29. 

  30. class RegistrationFactory(SessionFactory):
    31. 

  31.     """The Base Configurable for objects that involve registration."""
    32. 

  32.     
    33. 

  33.     url = Unicode('', config=True,
    34. 

  34.         help="""The 0MQ url used for registration. This sets transport, ip, and port
    35. 

  35.         in one variable. For example: url='tcp://127.0.0.1:12345' or
    36. 

  36.         url='epgm://*:90210'"""
    37. 

  37.         ) # url takes precedence over ip,regport,transport
    38. 

  38.     transport = Unicode('tcp', config=True,
    39. 

  39.         help="""The 0MQ transport for communications.  This will likely be
    40. 

  40.         the default of 'tcp', but other values include 'ipc', 'epgm', 'inproc'.""")
    41. 

  41.     ip = Unicode(config=True,
    42. 

  42.         help="""The IP address for registration.  This is generally either
    43. 

  43.         '127.0.0.1' for loopback only or '*' for all interfaces.
    44. 

  44.         """)
    45. 

  45.     def _ip_default(self):
    46. 

  46.         return localhost()
    47. 

  47.     regport = Integer(config=True,
    48. 

  48.         help="""The port on which the Hub listens for registration.""")
    49. 

  49.     def _regport_default(self):
    50. 

  50.         return select_random_ports(1)[0]
    51. 

  51.     
    52. 

  52.     def __init__(self, **kwargs):
    53. 

  53.         super(RegistrationFactory, self).__init__(**kwargs)
    54. 

  54.         self._propagate_url()
    55. 

  55.         self._rebuild_url()
    56. 

  56.         self.on_trait_change(self._propagate_url, 'url')
    57. 

  57.         self.on_trait_change(self._rebuild_url, 'ip')
    58. 

  58.         self.on_trait_change(self._rebuild_url, 'transport')
    59. 

  59.         self.on_trait_change(self._rebuild_url, 'regport')
    60. 

  60.     
    61. 

  61.     def _rebuild_url(self):
    62. 

  62.         self.url = "%s://%s:%i"%(self.transport, self.ip, self.regport)
    63. 

  63.         
    64. 

  64.     def _propagate_url(self):
    65. 

  65.         """Ensure self.url contains full transport://interface:port"""
    66. 

  66.         if self.url:
    67. 

  67.             iface = self.url.split('://',1)
    68. 

  68.             if len(iface) == 2:
    69. 

  69.                 self.transport,iface = iface
    70. 

  70.             iface = iface.split(':')
    71. 

  71.             self.ip = iface[0]
    72. 

  72.             if iface[1]:
    73. 

  73.                 self.regport = int(iface[1])
    74.