Merge branch 'master' into pr/11354

docs/source/whatsnew/pr/video-width-height.rst

@@ -0,0 +1,1 b''
+``IPython.display.Video`` now supports ``width`` and ``height`` arguments, allowing a custom width and height to be set instead of using the video's width and height
  No newline at end of file

IPython/core/display.py

@@ -238,16 +238,22 b' def display(*objs, include=None, exclude=None, metadata=None, transient=None, di'
     want to use. Here is a list of the names of the special methods and the
     values they must return:
 
-      - `_repr_html_`: return raw HTML as a string
-      - `_repr_json_`: return a JSONable dict
-      - `_repr_jpeg_`: return raw JPEG data
-      - `_repr_png_`: return raw PNG data
-      - `_repr_svg_`: return raw SVG data as a string
-      - `_repr_latex_`: return LaTeX commands in a string surrounded by "$".
+      - `_repr_html_`: return raw HTML as a string, or a tuple (see below).
+      - `_repr_json_`: return a JSONable dict, or a tuple (see below).
+      - `_repr_jpeg_`: return raw JPEG data, or a tuple (see below).
+      - `_repr_png_`: return raw PNG data, or a tuple (see below).
+      - `_repr_svg_`: return raw SVG data as a string, or a tuple (see below).
+      - `_repr_latex_`: return LaTeX commands in a string surrounded by "$",
+                        or a tuple (see below).
       - `_repr_mimebundle_`: return a full mimebundle containing the mapping
                              from all mimetypes to data.
                              Use this for any mime-type not listed above.
 
+    The above functions may also return the object's metadata alonside the
+    data.  If the metadata is available, the functions will return a tuple
+    containing the data and metadata, in that order.  If there is no metadata
+    available, then the functions will return the data only.
+
     When you are directly writing your own classes, you can adapt them for
     display in IPython by following the above approach. But in practice, you
     often need to work with existing classes that you can't easily modify.
@@ -666,6 +672,11 b' class Pretty(TextDisplayObject):'
 
 class HTML(TextDisplayObject):
 
+    def __init__(self, data=None, url=None, filename=None, metadata=None):
+        if data and "<iframe " in data and "</iframe>" in data:
+            warnings.warn("Consider using IPython.display.IFrame instead")
+        super(HTML, self).__init__(data=data, url=url, filename=filename, metadata=metadata)
+
     def _repr_html_(self):
         return self._data_and_metadata()
 
@@ -1256,7 +1267,8 b' class Image(DisplayObject):'
 
 class Video(DisplayObject):
 
-    def __init__(self, data=None, url=None, filename=None, embed=False, mimetype=None):
+    def __init__(self, data=None, url=None, filename=None, embed=False,
+                 mimetype=None, width=None, height=None):
         """Create a video object given raw data or an URL.
 
         When this object is returned by an input cell or passed to the
@@ -1288,6 +1300,12 b' class Video(DisplayObject):'
         mimetype: unicode
             Specify the mimetype for embedded videos.
             Default will be guessed from file extension, if available.
+        width : int
+            Width in pixels to which to constrain the video in HTML.
+            If not supplied, defaults to the width of the video.
+        height : int
+            Height in pixels to which to constrain the video in html.
+            If not supplied, defaults to the height of the video.
 
         Examples
         --------
@@ -1314,16 +1332,24 b' class Video(DisplayObject):'
 
         self.mimetype = mimetype
         self.embed = embed
+        self.width = width
+        self.height = height
         super(Video, self).__init__(data=data, url=url, filename=filename)
 
     def _repr_html_(self):
+        width = height = ''
+        if self.width:
+            width = ' width="%d"' % self.width
+        if self.height:
+            height = ' height="%d"' % self.height
+
         # External URLs and potentially local files are not embedded into the
         # notebook output.
         if not self.embed:
             url = self.url if self.url is not None else self.filename
-            output = """<video src="{0}" controls>
+            output = """<video src="{0}" controls {1} {2}>
       Your browser does not support the <code>video</code> element.
-    </video>""".format(url)
+    </video>""".format(url, width, height)
             return output
 
         # Embedded videos are base64-encoded.
@@ -1342,10 +1368,10 b' class Video(DisplayObject):'
         else:
             b64_video = b2a_base64(video).decode('ascii').rstrip()
 
-        output = """<video controls>
- <source src="data:{0};base64,{1}" type="{0}">
+        output = """<video controls {0} {1}>
+ <source src="data:{2};base64,{3}" type="{2}">
  Your browser does not support the video tag.
- </video>""".format(mimetype, b64_video)
+ </video>""".format(width, height, mimetype, b64_video)
         return output
 
     def reload(self):

IPython/core/inputtransformer2.py

@@ -20,10 +20,12 b" _indent_re = re.compile(r'^[ \\t]+')"
 
 def leading_indent(lines):
     """Remove leading indentation.
-    
+
     If the first line starts with a spaces or tabs, the same whitespace will be
     removed from each following line in the cell.
     """
+    if not lines:
+        return lines
     m = _indent_re.match(lines[0])
     if not m:
         return lines
@@ -34,7 +36,7 b' def leading_indent(lines):'
 
 class PromptStripper:
     """Remove matching input prompts from a block of input.
-    
+
     Parameters
     ----------
     prompt_re : regular expression
@@ -45,7 +47,7 b' class PromptStripper:'
         If no initial expression is given, prompt_re will be used everywhere.
         Used mainly for plain Python prompts (``>>>``), where the continuation prompt
         ``...`` is a valid Python expression in Python 3, so shouldn't be stripped.
-    
+
     If initial_re and prompt_re differ,
     only initial_re will be tested against the first line.
     If any prompt is found on the first two lines,
@@ -59,6 +61,8 b' class PromptStripper:'
         return [self.prompt_re.sub('', l, count=1) for l in lines]
 
     def __call__(self, lines):
+        if not lines:
+            return lines
         if self.initial_re.match(lines[0]) or \
                 (len(lines) > 1 and self.prompt_re.match(lines[1])):
             return self._strip(lines)
@@ -72,7 +76,7 b' classic_prompt = PromptStripper('
 ipython_prompt = PromptStripper(re.compile(r'^(In \[\d+\]: |\s*\.{3,}: ?)'))
 
 def cell_magic(lines):
-    if not lines[0].startswith('%%'):
+    if not lines or not lines[0].startswith('%%'):
         return lines
     if re.match('%%\w+\?', lines[0]):
         # This case will be handled by help_end
@@ -92,7 +96,7 b' def _find_assign_op(token_line):'
     for i, ti in enumerate(token_line):
         s = ti.string
         if s == '=' and paren_level == 0:
-            return i 
+            return i
         if s in '([{':
             paren_level += 1
         elif s in ')]}':
@@ -112,7 +116,7 b' def find_end_of_continued_line(lines, start_line: int):'
     return end_line
 
 def assemble_continued_line(lines, start: Tuple[int, int], end_line: int):
-    """Assemble a single line from multiple continued line pieces 
+    """Assemble a single line from multiple continued line pieces
 
     Continued lines are lines ending in ``\``, and the line following the last
     ``\`` in the block.
@@ -202,7 +206,7 b' class MagicAssign(TokenTransformBase):'
                     and (line[assign_ix+1].string == '%') \
                     and (line[assign_ix+2].type == tokenize.NAME):
                 return cls(line[assign_ix+1].start)
-    
+
     def transform(self, lines: List[str]):
         """Transform a magic assignment found by the ``find()`` classmethod.
         """
@@ -212,12 +216,12 b' class MagicAssign(TokenTransformBase):'
         rhs = assemble_continued_line(lines, (start_line, start_col), end_line)
         assert rhs.startswith('%'), rhs
         magic_name, _, args = rhs[1:].partition(' ')
-        
+
         lines_before = lines[:start_line]
         call = "get_ipython().run_line_magic({!r}, {!r})".format(magic_name, args)
         new_line = lhs + call + '\n'
         lines_after = lines[end_line+1:]
-        
+
         return lines_before + [new_line] + lines_after
 
 
@@ -464,7 +468,7 b' def make_tokens_by_line(lines):'
         pass
     if not tokens_by_line[-1]:
         tokens_by_line.pop()
-    
+
     return tokens_by_line
 
 def show_linewise_tokens(s: str):
@@ -501,12 +505,12 b' class TransformerManager:'
             EscapedCommand,
             HelpEnd,
         ]
-    
+
     def do_one_token_transform(self, lines):
         """Find and run the transform earliest in the code.
-        
+
         Returns (changed, lines).
-        
+
         This method is called repeatedly until changed is False, indicating
         that all available transformations are complete.
 

IPython/core/tests/test_display.py

@@ -195,6 +195,14 b' def test_displayobject_repr():'
     j._show_mem_addr = False
     nt.assert_equal(repr(j), '<IPython.core.display.Javascript object>')
 
[e-mail]('warnings.warn')
+def test_encourage_iframe_over_html(m_warn):
+    display.HTML('<br />')
+    m_warn.assert_not_called()
+
+    display.HTML('<iframe src="http://a.com"></iframe>')
+    m_warn.assert_called_with('Consider using IPython.display.IFrame instead')
+
 def test_progress():
     p = display.ProgressBar(10)
     nt.assert_in('0/10',repr(p))

IPython/core/tests/test_inputtransformer2.py

@@ -103,6 +103,12 b' b) = zip?'
 [r"get_ipython().set_next_input('(a,\nb) = zip');get_ipython().run_line_magic('pinfo', 'zip')" + "\n"]
 )
 
+def null_cleanup_transformer(lines):
+    """
+    A cleanup transform that returns an empty list.
+    """
+    return []
+
 def check_make_token_by_line_never_ends_empty():
     """
     Check that not sequence of single or double characters ends up leading to en empty list of tokens
@@ -226,3 +232,7 b' def test_check_complete():'
         for k in short:
             cc(c+k)
 
+def test_null_cleanup_transformer():
+    manager = ipt2.TransformerManager()
+    manager.cleanup_transforms.insert(0, null_cleanup_transformer)
+    nt.assert_is(manager.transform_cell(""), "")

docs/source/config/integrating.rst

@@ -65,6 +65,21 b' There are also two more powerful display methods:'
       Displays the object as a side effect; the return value is ignored. If this
       is defined, all other display methods are ignored.
 
+To customize how the REPL pretty-prints your object, add a `_repr_pretty_`
+method to the class.  The method should accept a pretty printer, and a boolean
+that indicates whether the printer detected a cycle.  The method should act on
+the printer to produce your customized pretty output.  Here is an example::
+
+    class MyObject(object):
+
+        def _repr_pretty_(self, p, cycle):
+            if cycle:
+                p.text('MyObject(...)')
+            else:
+                p.text('MyObject[...]')
+
+For details, see :py:mod:`IPython.lib.pretty`.
+
 Formatters for third-party types
 --------------------------------