Function YouCompleteMeInstance

python/ycm/tests/__init__.py:106–134

Defines a decorator function for tests that passes a unique YouCompleteMe instance as a parameter. This instance is initialized with the default options `DEFAULT_CLIENT_OPTIONS`. Use the optional parameter |custom_options| to give additional options and/or override the already existing ones.

( custom_options = {} )

def YouCompleteMeInstance( custom_options = {} ):
  """Defines a decorator function for tests that passes a unique YouCompleteMe
  instance as a parameter. This instance is initialized with the default options
  `DEFAULT_CLIENT_OPTIONS`. Use the optional parameter |custom_options| to give
  additional options and/or override the already existing ones.

  Example usage:

    from ycm.tests import YouCompleteMeInstance

    @YouCompleteMeInstance( { 'log_level': 'debug',
                              'keep_logfiles': 1 } )
    def Debug_test( ycm ):
        ...
  """
  def Decorator( test ):
    @functools.wraps( test )
    def Wrapper( test_case_instance, *args, **kwargs ):
      with UserOptions( custom_options ):
        ycm = YouCompleteMe()
        WaitUntilReady()
        ycm.CheckIfServerIsReady()
        try:
          test_utils.VIM_PROPS_FOR_BUFFER.clear()
          return test( test_case_instance, ycm, *args, **kwargs )
        finally:
          StopServer( ycm )
    return Wrapper
  return Decorator


@contextlib.contextmanager