Method tikz of polyhedron class can now return an object of type TikzPicture #33002

seblabbe · 2021-12-09T10:34:24Z

As a follow up of #20343, the current branch now allows to specify the output type of the tikz method of a polyhedron:

sage: co = polytopes.cuboctahedron()
sage: t = co.tikz([674,108,-731], 112, output_type='TikzPicture')
sage: t
\documentclass[tikz]{standalone}
\begin{document}
\begin{tikzpicture}%
        [x={(0.249656cm, -0.577639cm)},
        y={(0.777700cm, -0.358578cm)},
        z={(-0.576936cm, -0.733318cm)},
        scale=1.000000,
---
92 lines not printed (5190 characters in total).
Use print to see the full content.
---
\node[vertex] at (1.00000, 0.00000, 1.00000)     {};
\node[vertex] at (1.00000, 1.00000, 0.00000)     {};
%%
%%
\end{tikzpicture}
\end{document}
sage: t.pdf()
'/tmp/tmpobwhg3p7/tikz_o9dkz419.pdf'

We also change the default behavior in favor of output_type='TikzPicture'. A deprecation warnings is now sent when output_type is not given:

sage: co = polytopes.cuboctahedron()
sage: t = co.tikz([674,108,-731], 112)
... DeprecationWarning: Since SageMath 5.13 (ticket #12083), the method
 .tikz() of a polyhedron returns an object of type ``LatexExpr`` which is a 
Python str. Since SageMath 9.7, this default behavior of returning an object
 of type LatexExpr is deprecated as the default output will soon change to 
an object of type ``TikzPicture`` from the module sage.misc.latex_standalone
 (newly introduced in SageMath 9.6). Please update your code to specify the
 desired output type as ``.tikz(output_type='LatexExpr')`` to keep the old
 behavior or ``.tikz(output_type='TikzPicture')`` to use the future default
 behavior.
See https://trac.sagemath.org/33002 for details.

CC: @trevorkarn @jplab

Component: graphics

Author: Sébastien Labbé

Branch: 8729071

Reviewer: Laith Rastanawi

Issue created by migration from https://trac.sagemath.org/ticket/33002

The text was updated successfully, but these errors were encountered:

seblabbe · 2021-12-09T10:34:40Z

Dependencies: #20343

videlec · 2022-02-24T09:11:25Z

comment:3

What would be the interaction with sage/graphs/graph_latex.py?

seblabbe · 2022-06-30T09:44:18Z

Commit: 119baaf

seblabbe · 2022-06-30T09:44:18Z

New commits:

`119baaf`	`33002: tikz method of polyhedron can now output a TikzPicture object`

Refocussing this ticket on polyhedron only. Let's deal with tikz method for graph, posets, etc. in different tickets.

seblabbe · 2022-06-30T09:44:18Z

Branch: u/slabbe/33002

seblabbe · 2022-06-30T09:44:18Z

Author: Sébastien Labbé

LaisRast · 2022-07-05T09:48:27Z

Reviewer: Laith Rastanawi

LaisRast · 2022-07-05T09:48:27Z

comment:8

I would suggest to implement this for the function Projection.tikz() (of geometry.polyhedron.plot),
and then add the parameter output_type to Polyhedron_base6.tikz().

One reason for that is sometimes you may want to modify the projection before drawing the polytope using TikZ.
For instance in #34113:
you may want to choose a different window facet for the Schlegel projection before drawing the polytope.
So something like this should work:

P.schlegel_projection(P.facets()[1]).tikz([1, 0, 0], output_type="TikzPicture")

sagetrac-git · 2022-07-06T15:08:31Z

Branch pushed to git repo; I updated commit sha1. New commits:

`33afbd3`	`33002: moving the LatexExpr vs TikzPicture output type choice inside method projection().tikz() instead of tikz()`
`a1d5989`	`33002: adapting the doctests with the new behavior thus also avoiding deprecation warnings`

sagetrac-git · 2022-07-06T15:08:31Z

Changed commit from 119baaf to a1d5989

seblabbe · 2022-07-06T15:10:39Z

comment:10

Good comment. I did the change.

I also added a deprecation warning in favor of output_type='TikzPicture'.

I adapted the doctests in sage/geometry/polyhedron and in the doc.

Maybe there are remaining doctests to update? Let's see what the patchbots say.

seblabbe · 2022-07-06T15:10:39Z

Changed dependencies from #20343 to none

seblabbe · 2022-07-06T15:12:07Z

comment:11

Dear JP, it would be good for you eyes to look at the changes made in this ticket, because I am changing code and doc that you have written in the first place starting with #12083.

sagetrac-git · 2022-07-21T14:45:46Z

Branch pushed to git repo; I updated commit sha1. New commits:

`7a71bbe`	`33002: fixing small remarks in polytope_tikz.rst`

sagetrac-git · 2022-07-21T14:45:46Z

Changed commit from 4ef07a9 to 7a71bbe

seblabbe · 2022-07-21T14:48:52Z

comment:18

Replying to @LaisRast:

Seems good to me, except the following small remarks:

In polytope_tikz.rst:

Add full stop to the end of "... the raw TikZ picture of your polytope"

"you will have a file named.." -> " you will have two files.."

Thanks, i just added a commit which does that.

I suggest also:
``None``(deprecated) -> ``None`` (to be deprecated)

I think the definition of "deprecated" is that the option will be change or be gone in the future. An option is deprecated one or two years before it is gone. So, I keep it as it is for now.

Needs review. (I will be away from internet for the next two weeks).

LaisRast · 2022-07-21T15:47:01Z

comment:20

Looks good to me.

vbraun · 2022-07-26T20:33:20Z

comment:21

sage -t --long --warn-long 45.5 --random-seed=123 src/sage/misc/latex_standalone.py
**********************************************************************
File "src/sage/misc/latex_standalone.py", line 161, in sage.misc.latex_standalone
Failed example:
    s = P.projection().tikz([674,108,-731],112)
Expected nothing
Got:
    doctest:warning
      File "/home/release/Sage/src/bin/sage-runtests", line 153, in <module>
        err = DC.run()
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/site-packages/sage/doctest/control.py", line 1376, in run
        self.run_doctests()
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/site-packages/sage/doctest/control.py", line 1057, in run_doctests
        self.dispatcher.dispatch()
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/site-packages/sage/doctest/forker.py", line 2021, in dispatch
        self.parallel_dispatch()
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/site-packages/sage/doctest/forker.py", line 1916, in parallel_dispatch
        w.start()  # This might take some time
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/site-packages/sage/doctest/forker.py", line 2190, in start
        super().start()
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/multiprocessing/process.py", line 121, in start
        self._popen = self._Popen(self)
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/multiprocessing/context.py", line 224, in _Popen
        return _default_context.get_context().Process._Popen(process_obj)
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/multiprocessing/context.py", line 277, in _Popen
        return Popen(process_obj)
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/multiprocessing/popen_fork.py", line 19, in __init__
        self._launch(process_obj)
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/multiprocessing/popen_fork.py", line 71, in _launch
        code = process_obj._bootstrap(parent_sentinel=child_r)
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/multiprocessing/process.py", line 315, in _bootstrap
        self.run()
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/site-packages/sage/doctest/forker.py", line 2162, in run
        task(self.options, self.outtmpfile, msgpipe, self.result_queue)
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/site-packages/sage/doctest/forker.py", line 2492, in __call__
        doctests, extras = self._run(runner, options, results)
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/site-packages/sage/doctest/forker.py", line 2544, in _run
        result = runner.run(test)
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/site-packages/sage/doctest/forker.py", line 866, in run
        return self._run(test, compileflags, out)
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/site-packages/sage/doctest/forker.py", line 695, in _run
        self.compile_and_execute(example, compiler, test.globs)
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/site-packages/sage/doctest/forker.py", line 1093, in compile_and_execute
        exec(compiled, globs)
      File "<doctest sage.misc.latex_standalone[23]>", line 1, in <module>
        s = P.projection().tikz([Integer(674),Integer(108),-Integer(731)],Integer(112))
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/site-packages/sage/geometry/polyhedron/plot.py", line 1431, in tikz
        deprecation(33002, msg)
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/site-packages/sage/misc/superseded.py", line 99, in deprecation
        warning(trac_number, message, DeprecationWarning, stacklevel)
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/site-packages/sage/misc/superseded.py", line 180, in warning
        warn(message, warning_class, stacklevel)
      File "/home/release/Sage/local/var/lib/sage/venv-python3.10.5/lib/python3.10/warnings.py", line 109, in _showwarnmsg
        sw(msg.message, msg.category, msg.filename, msg.lineno,
    :
    DeprecationWarning: The default type of the returned object will soon be changed from `sage.misc.latex.LatexExpr` to `sage.misc.latex_standalone.TikzPicture`.  Please update your code to specify the desired output type as `.tikz(output_type='LatexExpr')` to keep the old behavior or `.tikz(output_type='TikzPicture')` to use the future default behavior.
    See https://trac.sagemath.org/33002 for details.
**********************************************************************

sagetrac-git · 2022-08-09T21:39:57Z

Changed commit from 7a71bbe to 8729071

sagetrac-git · 2022-08-09T21:39:57Z

Branch pushed to git repo; I updated commit sha1. New commits:

`8729071`	`33002: updating doctest to fix deprecation warning`

seblabbe · 2022-08-09T21:44:37Z

comment:23

Oups, I forgot that one. The other failures seen by the patchbot (related to giac) are unrelated.

Needs review.

seblabbe · 2022-08-30T14:47:12Z

comment:24

ping!

Maybe there is still a chance for this to get in 9.7 ...

LaisRast · 2022-09-04T09:09:34Z

comment:25

Sorry for the late reply.
Since now you fixed the test, the ticket is done.

vbraun · 2022-09-20T20:23:14Z

Changed branch from u/slabbe/33002 to 8729071

seblabbe · 2022-09-29T09:25:04Z

comment:28

I created #34606 to fix the doc, because this ticket was merged in 9.8 not in 9.7.

seblabbe · 2022-09-29T09:25:04Z

Changed commit from 8729071 to none

seblabbe added this to the sage-9.5 milestone Dec 9, 2021

seblabbe added c: graphics labels Dec 9, 2021

mkoeppe modified the milestones: sage-9.5, sage-9.6 Dec 18, 2021

mkoeppe modified the milestones: sage-9.6, sage-9.7 Apr 7, 2022

This comment has been minimized.

Sign in to view

seblabbe changed the title ~~Adding a method in graph, poset, polyhedron, etc. classes to return an object of type TikzPicture~~ Method tikz of polyhedron class can now return an object of type TikzPicture Jun 30, 2022

This comment has been minimized.

Sign in to view

seblabbe added the s: needs review label Jun 30, 2022

LaisRast added s: needs work and removed s: needs review labels Jul 5, 2022

seblabbe added s: needs review and removed s: needs work labels Jul 6, 2022

This comment has been minimized.

Sign in to view

LaisRast added s: needs work and removed s: needs review labels Jul 9, 2022

seblabbe added s: needs review and removed s: needs work labels Jul 21, 2022

LaisRast added s: positive review and removed s: needs review labels Jul 21, 2022

vbraun added s: needs work and removed s: positive review labels Jul 26, 2022

seblabbe added s: needs review and removed s: needs work labels Aug 9, 2022

LaisRast added s: positive review and removed s: needs review labels Sep 4, 2022

mkoeppe modified the milestones: sage-9.7, sage-9.8 Sep 19, 2022

vbraun removed the s: positive review label Sep 20, 2022

vbraun closed this as completed in 509ed92 Sep 20, 2022

seblabbe mentioned this issue Oct 16, 2022

fix doc with respect to a change in behavior for tikz method of polyhedron (since 9.7 -> since 9.8) #34606

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Method tikz of polyhedron class can now return an object of type TikzPicture #33002

Method tikz of polyhedron class can now return an object of type TikzPicture #33002

seblabbe commented Dec 9, 2021

seblabbe commented Dec 9, 2021

videlec commented Feb 24, 2022

seblabbe commented Jun 30, 2022

seblabbe commented Jun 30, 2022

seblabbe commented Jun 30, 2022

seblabbe commented Jun 30, 2022

This comment has been minimized.

This comment has been minimized.

LaisRast commented Jul 5, 2022

LaisRast commented Jul 5, 2022

sagetrac-git mannequin commented Jul 6, 2022

sagetrac-git mannequin commented Jul 6, 2022

seblabbe commented Jul 6, 2022

seblabbe commented Jul 6, 2022

seblabbe commented Jul 6, 2022

This comment has been minimized.

sagetrac-git mannequin commented Jul 21, 2022

sagetrac-git mannequin commented Jul 21, 2022

seblabbe commented Jul 21, 2022

LaisRast commented Jul 21, 2022

vbraun commented Jul 26, 2022

sagetrac-git mannequin commented Aug 9, 2022

sagetrac-git mannequin commented Aug 9, 2022

seblabbe commented Aug 9, 2022

seblabbe commented Aug 30, 2022

LaisRast commented Sep 4, 2022

vbraun commented Sep 20, 2022

seblabbe commented Sep 29, 2022

seblabbe commented Sep 29, 2022

Method tikz of polyhedron class can now return an object of type TikzPicture #33002

Method tikz of polyhedron class can now return an object of type TikzPicture #33002

Comments

seblabbe commented Dec 9, 2021

seblabbe commented Dec 9, 2021

videlec commented Feb 24, 2022

seblabbe commented Jun 30, 2022

seblabbe commented Jun 30, 2022

seblabbe commented Jun 30, 2022

seblabbe commented Jun 30, 2022

This comment has been minimized.

This comment has been minimized.

LaisRast commented Jul 5, 2022

LaisRast commented Jul 5, 2022

sagetrac-git mannequin commented Jul 6, 2022

sagetrac-git mannequin commented Jul 6, 2022

seblabbe commented Jul 6, 2022

seblabbe commented Jul 6, 2022

seblabbe commented Jul 6, 2022

This comment has been minimized.

sagetrac-git mannequin commented Jul 21, 2022

sagetrac-git mannequin commented Jul 21, 2022

seblabbe commented Jul 21, 2022

LaisRast commented Jul 21, 2022

vbraun commented Jul 26, 2022

sagetrac-git mannequin commented Aug 9, 2022

sagetrac-git mannequin commented Aug 9, 2022

seblabbe commented Aug 9, 2022

seblabbe commented Aug 30, 2022

LaisRast commented Sep 4, 2022

vbraun commented Sep 20, 2022

seblabbe commented Sep 29, 2022

seblabbe commented Sep 29, 2022